Class: MarkdownNodeParser
A NodeParser generates Nodes from Documents
Implements
Constructors
constructor
• new MarkdownNodeParser(init?): MarkdownNodeParser
Parameters
| Name | Type |
|---|---|
init? | Object |
init.includeMetadata? | boolean |
init.includePrevNextRel? | boolean |
Returns
Defined in
packages/core/src/nodeParsers/MarkdownNodeParser.ts:9
Properties
includeMetadata
• includeMetadata: boolean
Defined in
packages/core/src/nodeParsers/MarkdownNodeParser.ts:6
includePrevNextRel
• includePrevNextRel: boolean
Defined in
packages/core/src/nodeParsers/MarkdownNodeParser.ts:7
Methods
buildNodeFromSplit
▸ buildNodeFromSplit(textSplit, node, metadata): BaseNode<Metadata>
Parameters
| Name | Type |
|---|---|
textSplit | string |
node | BaseNode<Metadata> |
metadata | Metadata |
Returns
Defined in
packages/core/src/nodeParsers/MarkdownNodeParser.ts:28
getNodesFromDocuments
▸ getNodesFromDocuments(documents): BaseNode<Metadata>[]
Generates an array of nodes from an array of documents.
Parameters
| Name | Type | Description |
|---|---|---|
documents | BaseNode<Metadata>[] | The documents to generate nodes from. |
Returns
An array of nodes.
Implementation of
NodeParser.getNodesFromDocuments
Defined in
packages/core/src/nodeParsers/MarkdownNodeParser.ts:101
getNodesFromNode
▸ getNodesFromNode(node): BaseNode<Metadata>[]
Parameters
| Name | Type |
|---|---|
node | BaseNode<Metadata> |
Returns
Defined in
packages/core/src/nodeParsers/MarkdownNodeParser.ts:64
transform
▸ transform(nodes, _options?): Promise<BaseNode<Metadata>[]>
Parameters
| Name | Type |
|---|---|
nodes | BaseNode<Metadata>[] |
_options? | any |
Returns
Implementation of
Defined in
packages/core/src/nodeParsers/MarkdownNodeParser.ts:17
updateMetadata
▸ updateMetadata(headersMetadata, newHeader, newHeaderLevel): Metadata
Parameters
| Name | Type |
|---|---|
headersMetadata | Metadata |
newHeader | string |
newHeaderLevel | number |
Returns
Defined in
packages/core/src/nodeParsers/MarkdownNodeParser.ts:48
fromDefaults
▸ fromDefaults(init?): MarkdownNodeParser
Parameters
| Name | Type |
|---|---|
init? | Object |
init.includeMetadata? | boolean |
init.includePrevNextRel? | boolean |