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
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new HTMLReader():
HTMLReader
Returns
Section titled “Returns”HTMLReader
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”addMetaData()
Section titled “addMetaData()”
staticaddMetaData(filePath): (doc,index) =>void
Defined in: packages/core/src/schema/type.ts:94
Parameters
Section titled “Parameters”filePath
Section titled “filePath”string
Returns
Section titled “Returns”(
doc,index):void
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”loadData()
Section titled “loadData()”Defined in: packages/core/src/schema/type.ts:65
Parameters
Section titled “Parameters”filePath
Section titled “filePath”string
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”loadDataAsContent()
Section titled “loadDataAsContent()”loadDataAsContent(
fileContent):Promise<Document<Metadata>[]>
Defined in: packages/readers/src/html.ts:18
Public method for this reader. Required by BaseReader interface.
Parameters
Section titled “Parameters”fileContent
Section titled “fileContent”Uint8Array
The content of the file.
Returns
Section titled “Returns”Promise<Document[]> A Promise object, eventually yielding zero or one Document parsed from the HTML content of the specified file.
Overrides
Section titled “Overrides”parseContent()
Section titled “parseContent()”parseContent(
html,options):Promise<string>
Defined in: packages/readers/src/html.ts:33
Wrapper for string-strip-html usage.
Parameters
Section titled “Parameters”string
Raw HTML content to be parsed.
options
Section titled “options”Partial<Opts> = {}
An object of options for the underlying library
Returns
Section titled “Returns”Promise<string>
The HTML content, stripped of unwanted tags and attributes
getOptions
getOptions()
Section titled “getOptions()”getOptions():
Partial<Opts>
Defined in: packages/readers/src/html.ts:46
Wrapper for our configuration options passed to string-strip-html library
Returns
Section titled “Returns”Partial<Opts>
An object of options for the underlying library