メインコンテンツまでスキップ

Class: HTMLReader

Extract the significant text from an arbitrary HTML document. The contents of any head, script, style, and xml tags are removed completely. The URLs for a[href] tags are extracted, along with the inner text of the tag. All other tags are removed, and the inner text is kept intact. Html entities (e.g., &) are not decoded.

Implements

Constructors

constructor

new HTMLReader(): HTMLReader

Returns

HTMLReader

Methods

getOptions

getOptions(): Object

Wrapper for our configuration options passed to string-strip-html library

Returns

Object

An object of options for the underlying library

NameType
skipHtmlDecodingboolean
stripTogetherWithTheirContentsstring[]

See

https://codsen.com/os/string-strip-html/examples

Defined in

packages/core/src/readers/HTMLReader.ts:48


loadData

loadData(file, fs?): Promise<Document<Metadata>[]>

Public method for this reader. Required by BaseReader interface.

Parameters

NameTypeDefault valueDescription
filestringundefinedPath/name of the file to be loaded.
fsGenericFileSystemdefaultFSfs wrapper interface for getting the file content.

Returns

Promise<Document<Metadata>[]>

Promise<Document[]> A Promise object, eventually yielding zero or one Document parsed from the HTML content of the specified file.

Implementation of

BaseReader.loadData

Defined in

packages/core/src/readers/HTMLReader.ts:21


parseContent

parseContent(html, options?): Promise<string>

Wrapper for string-strip-html usage.

Parameters

NameTypeDescription
htmlstringRaw HTML content to be parsed.
optionsanyAn object of options for the underlying library

Returns

Promise<string>

The HTML content, stripped of unwanted tags and attributes

See

getOptions

Defined in

packages/core/src/readers/HTMLReader.ts:38