Class: MarkdownReader
Extract text from markdown files. Returns dictionary with keys as headers and values as the text between headers.
Implements
Constructors
constructor
• new MarkdownReader(removeHyperlinks?, removeImages?)
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
removeHyperlinks? | boolean | true | Indicates whether hyperlinks should be removed. |
removeImages? | boolean | true | Indicates whether images should be removed. |
Defined in
Properties
_removeHyperlinks
• Private _removeHyperlinks: boolean
Defined in
_removeImages
• Private _removeImages: boolean
Defined in
Methods
loadData
▸ loadData(file, fs?): Promise<Document[]>
Parameters
| Name | Type | Default value |
|---|---|---|
file | string | undefined |
fs | GenericFileSystem | DEFAULT_FS |
Returns
Promise<Document[]>
Implementation of
Defined in
markdownToTups
▸ markdownToTups(markdownText): MarkdownTuple[]
Convert a markdown file to a dictionary. The keys are the headers and the values are the text under each header.
Parameters
| Name | Type | Description |
|---|---|---|
markdownText | string | The markdown text to convert. |
Returns
MarkdownTuple[]
- An array of tuples, where each tuple contains a header (or null) and its corresponding text.
Defined in
parseTups
▸ parseTups(content): MarkdownTuple[]
Parameters
| Name | Type |
|---|---|
content | string |
Returns
MarkdownTuple[]
Defined in
removeHyperlinks
▸ removeHyperlinks(content): string
Parameters
| Name | Type |
|---|---|
content | string |
Returns
string
Defined in
removeImages
▸ removeImages(content): string
Parameters
| Name | Type |
|---|---|
content | string |
Returns
string