NodeParser
Defined in: .build/typescript/packages/core/src/node-parser/base.ts:12
Extends
Section titled “Extends”TransformComponent
<Result
>
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”Result
Section titled “Result”Result
extends TextNode
[] | Promise
<TextNode
[]> = TextNode
[] | Promise
<TextNode
[]>
abstract
NodeParser<Options
>(nodes
,options?
):Result
Defined in: .build/typescript/packages/core/src/node-parser/base.ts:12
Type Parameters
Section titled “Type Parameters”Options
Section titled “Options”Options
extends Record
<string
, unknown
>
Parameters
Section titled “Parameters”options?
Section titled “options?”Options
Returns
Section titled “Returns”Result
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new NodeParser<
Result
>():NodeParser
<Result
>
Defined in: .build/typescript/packages/core/src/node-parser/base.ts:20
Returns
Section titled “Returns”NodeParser
<Result
>
Overrides
Section titled “Overrides”TransformComponent
.constructor
Properties
Section titled “Properties”includeMetadata
Section titled “includeMetadata”includeMetadata:
boolean
=true
Defined in: .build/typescript/packages/core/src/node-parser/base.ts:17
includePrevNextRel
Section titled “includePrevNextRel”includePrevNextRel:
boolean
=true
Defined in: .build/typescript/packages/core/src/node-parser/base.ts:18
id:
string
Defined in: .build/typescript/packages/core/src/schema/type.ts:22
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”postProcessParsedNodes()
Section titled “postProcessParsedNodes()”
protected
postProcessParsedNodes(nodes
,parentDocMap
):Awaited
<Result
>
Defined in: .build/typescript/packages/core/src/node-parser/base.ts:27
Parameters
Section titled “Parameters”Awaited
<Result
>
parentDocMap
Section titled “parentDocMap”Map
<string
, TextNode
<Metadata
>>
Returns
Section titled “Returns”Awaited
<Result
>
parseNodes()
Section titled “parseNodes()”
abstract
protected
parseNodes(documents
,showProgress?
):Result
Defined in: .build/typescript/packages/core/src/node-parser/base.ts:79
Parameters
Section titled “Parameters”documents
Section titled “documents”showProgress?
Section titled “showProgress?”boolean
Returns
Section titled “Returns”Result
getNodesFromDocuments()
Section titled “getNodesFromDocuments()”getNodesFromDocuments(
documents
):Result
Defined in: .build/typescript/packages/core/src/node-parser/base.ts:84
Parameters
Section titled “Parameters”documents
Section titled “documents”Returns
Section titled “Returns”Result