site/node_modules/mdast-util-gfm-table/index.d.ts
2024-10-14 08:09:33 +02:00

55 lines
999 B
TypeScript
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

export type {Options} from './lib/index.js'
export {gfmTableFromMarkdown, gfmTableToMarkdown} from './lib/index.js'
// Add custom data tracked to turn markdown into a tree.
declare module 'mdast-util-from-markdown' {
interface CompileData {
/**
* Whether were currently in a table.
*/
inTable?: boolean | undefined
}
}
// Add custom data tracked to turn a syntax tree into markdown.
declare module 'mdast-util-to-markdown' {
interface ConstructNameMap {
/**
* Whole table.
*
* ```markdown
* > | | a |
* ^^^^^
* > | | - |
* ^^^^^
* ```
*/
table: 'table'
/**
* Table cell.
*
* ```markdown
* > | | a |
* ^^^^^
* | | - |
* ```
*/
tableCell: 'tableCell'
/**
* Table row.
*
* ```markdown
* > | | a |
* ^^^^^
* | | - |
* ```
*/
tableRow: 'tableRow'
}
}
// Note: `Table` is exposed from `@types/mdast`.