Logo
Classes

HTMLReader

Defined in: packages/readers/src/html.ts:11

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.

Extends

  • FileReader<Document>

Constructors

Constructor

new HTMLReader(): HTMLReader

Returns

HTMLReader

Inherited from

FileReader<Document>.constructor

Methods

loadDataAsContent()

loadDataAsContent(fileContent): Promise<Document<Metadata>[]>

Defined in: packages/readers/src/html.ts:18

Public method for this reader. Required by BaseReader interface.

Parameters

fileContent

Uint8Array

The content of the file.

Returns

Promise<Document<Metadata>[]>

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

Overrides

FileReader.loadDataAsContent


parseContent()

parseContent(html, options): Promise<string>

Defined in: packages/readers/src/html.ts:33

Wrapper for string-strip-html usage.

Parameters

html

string

Raw HTML content to be parsed.

options

Partial<Opts> = {}

An object of options for the underlying library

Returns

Promise<string>

The HTML content, stripped of unwanted tags and attributes

See

getOptions


getOptions()

getOptions(): Partial<Opts>

Defined in: packages/readers/src/html.ts:46

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

Returns

Partial<Opts>

An object of options for the underlying library

See

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

On this page