ts-mdast - Typescript utilities for Markdown Abstract Syntax Tree

This package provides utilities to work with Markdown abstract syntax tree (_MDAST_). It contains:

- functions to create the different node types (also useful in pure _Javascript_);
- type guard and assertion functions to ensure the node is of expected type (especially useful with _Typescript_).

This package also re-export all types of @types/mdast and type of @types/unist which are useful for Markdown. It is therefore not necessary to include those packages if you are using this one.

Language/langue

Documents, messages, code (including variable names and comments), are in English.

Anyway, because Slune is French firm, all documents and important messages must also be provided in French. Other translations are welcome.

:fr: Une version française de ce document se trouve ici.

Installation

Installation is done using npm install command:

``bash
$ npm install --save ts-mdast
`

Usage

For each _NodeType_ node type, the package contains :

- an assertNodeType(node: Node) function raising an exception if node is not of type NodeType ;
- an isNodeType(node: Node) function returning true if node is of type NodeType ;
- a createNodeType(...) function creating a node of type _NodeType_.

The first two functions are understood by _Typescript_ which is after able to control the node type in an appropriate way.

The creation function is used this as following:

createNodeType(mandatory1, mandatory2 [, optional1 [, optional2 [, optional3]] | {optional1, optional2, optional3}] [, children])

where mandatory_ represent the mandatory parameters, optional_ the optional parameters and children an array with child nodes. Following calls are therefore possible:

`typescript
createNodeType(mandatory1, mandatory2, optional1, [child1, child2])
createNodeType(mandatory1, mandatory2, optional1, optional2)
createNodeType(mandatory1, mandatory2, { optional1, optional3 })
createNodeType(mandatory1, mandatory2, { optional2, optional3 }, [child1, child2])
createNodeType(mandatory1, mandatory2, [child1, child2])
`

The array containing children is directly used in the node and can therefore be modified after node creation:

`typescript
const children: Content[] = []
createNodeType(mandatory1, mandatory2, children)
children.push(createNodeType(mandatory1, mandatory2))
`

Notes:

- The createNodeType(...) function only exists for concrete nodes (not on Content nor BlockContent for example).
- All node types do not have mandatory parameters, optional parameters or child nodes.

Nodes

$3

Reference: Parent

Type assertion:

`typescript
function assertParent(node: Node): asserts node is Parent
`

Type guard:

`typescript
function isParent(node: Node): node is Parent
`

$3

Reference: Literal

Type assertion:

`typescript
function assertLiteral(node: Node): asserts node is Literal
`

Type guard:

`typescript
function isLiteral(node: Node): node is Literal
`

$3

Reference: Content

Type assertion:

`typescript
function assertContent(node: Node): asserts node is Content
`

Type guard:

`typescript
function isContent(node: Node): node is Content
`

$3

Reference: TopLevelContent

Type assertion:

`typescript
function assertTopLevelContent(node: Node): asserts node is TopLevelContent
`

Type guard:

`typescript
function isTopLevelContent(node: Node): node is TopLevelContent
`

$3

Reference: BlockContent

Type assertion:

`typescript
function assertBlockContent(node: Node): asserts node is BlockContent
`

Type guard:

`typescript
function isBlockContent(node: Node): node is BlockContent
`

$3

Reference: FrontmatterContent

Type assertion:

`typescript
function assertFrontmatterContent(node: Node): asserts node is FrontmatterContent
`

Type guard:

`typescript
function isFrontmatterContent(node: Node): node is FrontmatterContent
`

$3

Reference: DefinitionContent

Type assertion:

`typescript
function assertDefinitionContent(node: Node): asserts node is DefinitionContent
`

Type guard:

`typescript
function isDefinitionContent(node: Node): node is DefinitionContent
`

$3

Reference: ListContent

Type assertion:

`typescript
function assertListContent(node: Node): asserts node is ListContent
`

Type guard:

`typescript
function isListContent(node: Node): node is ListContent
`

$3

Reference: TableContent

Type assertion:

`typescript
function assertTableContent(node: Node): asserts node is TableContent
`

Type guard:

`typescript
function isTableContent(node: Node): node is TableContent
`

$3

Reference: RowContent

Type assertion:

`typescript
function assertRowContent(node: Node): asserts node is RowContent
`

Type guard:

`typescript
function isRowContent(node: Node): node is RowContent
`

$3

Reference: PhrasingContent

Type assertion:

`typescript
function assertPhrasingContent(node: Node): asserts node is PhrasingContent
`

Type guard:

`typescript
function isPhrasingContent(node: Node): node is PhrasingContent
`

$3

Reference: StaticPhrasingContent

Type assertion:

`typescript
function assertStaticPhrasingContent(node: Node): asserts node is StaticPhrasingContent
`

Type guard:

`typescript
function isStaticPhrasingContent(node: Node): node is StaticPhrasingContent
`

$3

Reference: Root

Type assertion:

`typescript
function assertRoot(node: Node): asserts node is Root
`

Type guard:

`typescript
function isRoot(node: Node): node is Root
`

Creation:

`typescript
function createRoot(children?: Content[]): Root
`

$3

Reference: Paragraph

Type assertion:

`typescript
function assertParagraph(node: Node): asserts node is Paragraph
`

Type guard:

`typescript
function isParagraph(node: Node): node is Paragraph
`

Creation:

`typescript
function createParagraph(children?: PhrasingContent[]): Paragraph
`

$3

Reference: Heading

Type assertion:

`typescript
function assertHeading(node: Node): asserts node is Heading
`

Type guard:

`typescript
function isHeading(node: Node): node is Heading
`

Creation:

`typescript
function createHeading(depth: 1 | 2 | 3 | 4 | 5 | 6, children?: PhrasingContent[])
`

$3

Reference: ThematicBreak

Type assertion:

`typescript
function assertThematicBreak(node: Node): asserts node is ThematicBreak
`

Type guard:

`typescript
function isThematicBreak(node: Node): node is ThematicBreak
`

Creation:

`typescript
function createThematicBreak(): ThematicBreak
`

$3

Reference: Blockquote

Type assertion:

`typescript
function assertBlockquote(node: Node): asserts node is Blockquote
`

Type guard:

`typescript
function isBlockquote(node: Node): node is Blockquote
`

Creation:

`typescript
function createBlockquote(children?: BlockContent[]): Blockquote
`

$3

Reference: List

Type assertion:

`typescript
function assertList(node: Node): asserts node is List
`

Type guard:

`typescript
function isList(node: Node): node is List
`

Creation:

`typescript
function createList(ordered: boolean, start: number, spread: boolean, children?: ListContent[]): List
function createList(ordered: boolean, start: number, children?: ListContent[]): List
function createList(ordered: boolean, children?: ListContent[]): List
function createList(children?: ListContent[]): List
function createList(
options: { ordered?: boolean; start?: number; spread?: boolean },
children?: ListContent[]
): List
`

$3

Reference: ListItem

Type assertion:

`typescript
function assertListItem(node: Node): asserts node is ListItem
`

Type guard:

`typescript
function isListItem(node: Node): node is ListItem
`

Creation:

`typescript
function createListItem(checked: boolean, spread: boolean, children?: BlockContent[]): ListItem
function createListItem(checked: boolean, children?: BlockContent[]): ListItem
function createListItem(children?: BlockContent[]): ListItem
function createListItem(
options: { checked?: boolean; spread?: boolean },
children?: BlockContent[]
): ListItem
`

$3

Reference: Table

Type assertion:

`typescript
function assertTable(node: Node): asserts node is Table
`

Type guard:

`typescript
function isTable(node: Node): node is Table
`

Creation:

`typescript
function createTable(align: AlignType[], children?: TableContent[]): Table
function createTable(children?: TableContent[]): Table
function createTable(options: { align?: AlignType[] }, children?: TableContent[]): Table
`

$3

Reference: TableRow

Type assertion:

`typescript
function assertTableRow(node: Node): asserts node is TableRow
`

Type guard:

`typescript
function isTableRow(node: Node): node is TableRow
`

Creation:

`typescript
function createTableRow(children?: RowContent[]): TableRow
`

$3

Reference: TableCell

Type assertion:

`typescript
function assertTableCell(node: Node): asserts node is TableCell
`

Type guard:

`typescript
function isTableCell(node: Node): node is TableCell
`

Creation:

`typescript
function createTableCell(children?: PhrasingContent[]): TableCell
`

$3

Reference: HTML

Type assertion:

`typescript
function assertHTML(node: Node): asserts node is HTML
`

Type guard:

`typescript
function isHTML(node: Node): node is HTML
`

Creation:

`typescript
function createHTML(value: string): HTML
`

$3

Reference: Code

Type assertion:

`typescript
function assertCode(node: Node): asserts node is Code
`

Type guard:

`typescript
function isCode(node: Node): node is Code
`

Creation:

`typescript
function createCode(value: string, lang?: string, meta?: string): Code
function createCode(value: string, options: { lang?: string; meta?: string }): Code
`

$3

Reference: YAML

Type assertion:

`typescript
function assertYAML(node: Node): asserts node is YAML
`

Type guard:

`typescript
function isYAML(node: Node): node is YAML
`

Creation:

`typescript
function createYAML(value: string): YAML
`

$3

Reference: Definition

Type assertion:

`typescript
function assertDefinition(node: Node): asserts node is Definition
`

Type guard:

`typescript
function isDefinition(node: Node): node is Definition
`

Creation:

`typescript
function createDefinition(identifier: string, url: string, label?: string, title?: string): Definition
function createDefinition(
identifier: string,
url: string,
options: { label?: string; title?: string }
): Definition
`

$3

Reference: FootnoteDefinition

Type assertion:

`typescript
function assertFootnoteDefinition(node: Node): asserts node is FootnoteDefinition
`

Type guard:

`typescript
function isFootnoteDefinition(node: Node): node is FootnoteDefinition
`

Creation:

`typescript
function createFootnoteDefinition(
identifier: string,
label: string,
children?: BlockContent[]
): FootnoteDefinition
function createFootnoteDefinition(identifier: string, children?: BlockContent[]): FootnoteDefinition
function createFootnoteDefinition(
identifier: string,
options: { label?: string },
children?: BlockContent[]
): FootnoteDefinition
`

$3

Reference: Text

Type assertion:

`typescript
function assertText(node: Node): asserts node is Text
`

Type guard:

`typescript
function isText(node: Node): node is Text
`

Creation:

`typescript
function createText(value: string): Text
`

$3

Reference: Emphasis

Type assertion:

`typescript
function assertEmphasis(node: Node): asserts node is Emphasis
`

Type guard:

`typescript
function isEmphasis(node: Node): node is Emphasis
`

Creation:

`typescript
function createEmphasis(children?: PhrasingContent[]): Emphasis
`

$3

Reference: Strong

Type assertion:

`typescript
function assertStrong(node: Node): asserts node is Strong
`

Type guard:

`typescript
function isStrong(node: Node): node is Strong
`

Creation:

`typescript
function createStrong(children?: PhrasingContent[]): Strong
`

$3

Reference: Delete

Type assertion:

`typescript
function assertDelete(node: Node): asserts node is Delete
`

Type guard:

`typescript
function isDelete(node: Node): node is Delete
`

Creation:

`typescript
function createDelete(children?: PhrasingContent[]): Delete
`

$3

Reference: InlineCode

Type assertion:

`typescript
function assertInlineCode(node: Node): asserts node is InlineCode
`

Type guard:

`typescript
function isInlineCode(node: Node): node is InlineCode
`

Creation:

`typescript
function createInlineCode(value: string): InlineCode
`

$3

Reference: Break

Type assertion:

`typescript
function assertBreak(node: Node): asserts node is Break
`

Type guard:

`typescript
function isBreak(node: Node): node is Break
`

Creation:

`typescript
function createBreak(): Break
`

$3

Reference: Link

Type assertion:

`typescript
function assertLink(node: Node): asserts node is Link
`

Type guard:

`typescript
function isLink(node: Node): node is Link
`

Creation:

`typescript
function createLink(url: string, title: string, children?: StaticPhrasingContent[]): Link
function createLink(url: string, children?: StaticPhrasingContent[]): Link
function createLink(url: string, options: { title?: string }, children?: StaticPhrasingContent[]): Link
`

$3

Reference: Image

Type assertion:

`typescript
function assertImage(node: Node): asserts node is Image
`

Type guard:

`typescript
function isImage(node: Node): node is Image
`

Creation:

`typescript
function createImage(url: string, alt?: string, title?: string): Image
function createImage(url: string, options: { alt?: string; title?: string }): Image
`

$3

Reference: LinkReference

Type assertion:

`typescript
function assertLinkReference(node: Node): asserts node is LinkReference
`

Type guard:

`typescript
function isLinkReference(node: Node): node is LinkReference
`

Creation:

`typescript
function createLinkReference(
identifier: string,
referenceType: ReferenceType,
label: string,
children?: StaticPhrasingContent[]
): LinkReference
function createLinkReference(
identifier: string,
referenceType: ReferenceType,
children?: StaticPhrasingContent[]
): LinkReference
function createLinkReference(
identifier: string,
referenceType: ReferenceType,
options: { label?: string },
children?: StaticPhrasingContent[]
): LinkReference
`

$3

Reference: ImageReference

Type assertion:

`typescript
function assertImageReference(node: Node): asserts node is ImageReference
`

Type guard:

`typescript
function isImageReference(node: Node): node is ImageReference
`

Creation:

`typescript
function createImageReference(
identifier: string,
referenceType: ReferenceType,
alt?: string,
label?: string
): ImageReference
function createImageReference(
identifier: string,
referenceType: ReferenceType,
options: { alt?: string; label?: string }
): ImageReference
`

$3

Reference: Footnote

Type assertion:

`typescript
function assertFootnote(node: Node): asserts node is Footnote
`

Type guard:

`typescript
function isFootnote(node: Node): node is Footnote
`

Creation:

`typescript
function createFootnote(children?: PhrasingContent[]): Footnote
`

$3

Reference: FootnoteReference

Type assertion:

`typescript
function assertFootnoteReference(node: Node): asserts node is FootnoteReference
`

Type guard:

`typescript
function isFootnoteReference(node: Node): node is FootnoteReference
`

Creation:

`typescript
function createFootnoteReference(identifier: string, label?: string): FootnoteReference
function createFootnoteReference(identifier: string, options: { label?: string }): FootnoteReference
``

Contributing

Even though we cannot guarantee a response time, please feel free to file an issue if you have any question or problem using the package.

_Pull Requests_ are welcome. You can, of course, submit corrections or improvements for code, but do not hesitate to also improve documentation, even for small spell or grammar errors.