parse-markdown-table — Reference

Index

Classes

Interfaces

TableIterationOptions

Variables

horizontalLineRegex

Functions

Variables

Const horizontalLineRegex

horizontalLineRegex: RegExp = /^[| -]+$/

Functions

createMarkdownArrayTable

createMarkdownArrayTable(stream: Stream): Promise<MarkdownCellTable>

- Defined in lib.ts:71
Parameters
- stream: Stream
Returns Promise<MarkdownCellTable>

createMarkdownArrayTableSync

createMarkdownArrayTableSync(text: string): MarkdownCellTableSync

- Defined in lib.ts:90
Parameters
- text: string
Returns MarkdownCellTableSync

createMarkdownObjectTable

createMarkdownObjectTable(stream: Stream): Promise<any>

- Defined in lib.ts:110
Parameters
- stream: Stream
Returns Promise<any>

createMarkdownObjectTableSync

createMarkdownObjectTableSync(text: string): any

- Defined in lib.ts:114
Parameters
- text: string
Returns any

iterateRows

iterateRows(lines: Stream, options: TableIterationOptions): AsyncGenerator<any, void, unknown>

- Defined in lib.ts:15
Parameters
- lines: Stream
- options: TableIterationOptions
Returns AsyncGenerator<any, void, unknown>

iterateRowsSync

iterateRowsSync(lines: Iterable<string>, options: TableIterationOptions): Generator<string[], void, unknown>

- Defined in lib.ts:36
Parameters
- lines: Iterable<string>
- options: TableIterationOptions
Returns Generator<string[], void, unknown>

Generated using TypeDoc