{"_id":"ts-mdast","_rev":"2-34b964e56ade0f8b37acb4bfecdf84a3","name":"ts-mdast","dist-tags":{"latest":"1.0.0"},"versions":{"0.1.0":{"name":"ts-mdast","version":"0.1.0","description":"Typescript utilities for Markdown Abstract Syntax Tree","keywords":["markdown","abstract syntax tree","syntax tree","mdast","typescript","create","type guard","guard"],"homepage":"https://github.com/slune-org/ts-mdast#readme","bugs":{"url":"https://github.com/slune-org/ts-mdast/issues"},"repository":{"type":"git","url":"git+https://github.com/slune-org/ts-mdast.git"},"license":"MIT","author":{"name":"Slune"},"type":"commonjs","main":"./lib/index.js","typings":"./lib/index.d.ts","scripts":{"prepublishOnly":"pm-exec run all","all":"pm-exec run clean && pm-exec run test && pm-exec run build","test":"pm-exec run test:lint && pm-exec run test:depends && pm-exec run test:unit","test:lint":"eslint --config .eslintrc.full.yaml 'src/**/*.ts'","test:depends":"depcheck","test:unit":"nyc mocha 'src/**/*.spec.ts'","build":"pm-exec run build:main","build:main":"tsc --project tsconfig.project.json","debug":"pm-exec run debug:watch","debug:watch":"onchange 'src/**' -- pm-exec run test:unit","clean":"rimraf lib"},"dependencies":{"@types/mdast":"^3.0.3","@types/unist":"^2.0.3"},"devDependencies":{"@istanbuljs/nyc-config-typescript":"1.0.1","@types/chai":"4.2.11","@types/chai-as-promised":"7.1.2","@types/mocha":"7.0.2","@types/node":"13.9.3","@typescript-eslint/eslint-plugin":"2.24.0","@typescript-eslint/parser":"2.24.0","chai":"4.2.0","chai-as-promised":"7.1.1","depcheck":"0.9.2","eslint":"6.8.0","eslint-config-prettier":"6.10.1","eslint-plugin-import":"2.20.1","eslint-plugin-jsdoc":"22.1.0","eslint-plugin-node":"11.0.0","eslint-plugin-prettier":"3.1.2","mocha":"7.1.1","nyc":"15.0.0","onchange":"6.1.0","pm-exec":"1.0.0","prettier":"2.0.1","remark-parse":"7.0.2","remark-stringify":"7.0.4","rimraf":"3.0.2","source-map-support":"0.5.16","ts-node":"8.8.1","typescript":"3.8.3","unified":"8.4.2"},"peerDependencies":{},"engines":{"node":">=10.0.0"},"gitHead":"2b8078d870ddba6906e7b15191af786e00058984","_id":"ts-mdast@0.1.0","_nodeVersion":"12.14.0","_npmVersion":"6.13.4","dist":{"integrity":"sha512-6fJU6ZrqTQS83BfYQNW+9eT8RyhBgj30W4PmbGdWvCDfoUu2Nq6RUuOOfCtZEk/9d4z6Fy1eyjIL4BUCxCL8XQ==","shasum":"cb39a43b96b84abad5db9c4e8132aba5c00c535c","tarball":"https://registry.npmjs.org/ts-mdast/-/ts-mdast-0.1.0.tgz","fileCount":57,"unpackedSize":41221,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeeOZlCRA9TVsSAnZWagAAoCwQAIAk+TkldweVQQX39cVC\nooceSYBNVGaoexsK/9VCoC6hy0hzkWKm4cFJe1EvCFYpTw7UKzB27lU9JJ85\n7a2breFyRQ95lTbmq85MG+YwkL1lj/9vE/h7RAxXsn4voKo6Nx56YYysD1RL\nVpqC49qyVAVhS3H9SYSjKR0lTjh0gCXT0jNHmhJP9TXnIZ/ubFJEsQ4gUPHb\ndHIXix3OzoCbMJAaihUsHILWZvYfLDJUnGCsfCWihpXS9e4BZnO5xD3yZUsy\nXiLjSVR+y3HOYZngxFKmSUdYE/MQhbeouCqxw9kvI2VlB4VhoC/elvvLkJa4\nZs+zIsJvVYJ1UCeomXbYuR7GA03rTiF7zYLPdOLaplHqUJvSh6oY8Jpyd9d4\nwIwoaM+D0zx6THvjI4Nhy9d2d5jHmI3y9i0tTDDuF7mEAcVsxdixUCgBykme\nXlQldkoyKo4Z3Rci4cBhuprUhM05OCwM7sJZuy3NEXZJspkp9NjqFK5f0Hf7\nUfY8vgVRdw/UHbqDnsX39e/l/8HlOg4G3rNRMGIbbJeAKouHB4c0CTETetj3\nWLqbjVZJGfsZMrWea7sowKVq23xhKlt+GNL7+mQrOSwFzE4Lkk9cHLzoK1x2\nt5H322P3+KOkNLMCDP6D7pbS4MZmI2qoBbroJIas6jlo6VUS/j4bqwkdHafY\nYK3L\r\n=WvCr\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCGIDUkkM8KGvKCVkgVkMX94J12ACc3SoEl0Tk7Q1Z65QIhANrwD/cSmWwa7JwgNwKbbTgZ1TgWI84aACDY7HLIqyv4"}]},"maintainers":[{"name":"sveyret","email":"sveyret@gmail.com"}],"_npmUser":{"name":"sveyret","email":"sveyret@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ts-mdast_0.1.0_1584981604767_0.7639355610340415"},"_hasShrinkwrap":false},"1.0.0":{"name":"ts-mdast","version":"1.0.0","description":"Typescript utilities for Markdown Abstract Syntax Tree","keywords":["markdown","abstract syntax tree","syntax tree","mdast","typescript","create","type guard","guard"],"homepage":"https://github.com/slune-org/ts-mdast#readme","bugs":{"url":"https://github.com/slune-org/ts-mdast/issues"},"repository":{"type":"git","url":"git+https://github.com/slune-org/ts-mdast.git"},"license":"MIT","author":{"name":"Slune"},"type":"commonjs","main":"./lib/index.js","typings":"./lib/index.d.ts","scripts":{"prepublishOnly":"pm-exec run all","all":"pm-exec run clean && pm-exec run test && pm-exec run build","test":"pm-exec run test:lint && pm-exec run test:depends && pm-exec run test:unit","test:lint":"eslint --config .eslintrc.full.yaml 'src/**/*.ts'","test:depends":"depcheck","test:unit":"cross-env TS_NODE_FILES=true nyc mocha 'src/**/*.spec.ts'","build":"pm-exec run build:main","build:main":"tsc --project tsconfig.project.json","debug":"pm-exec run debug:watch","debug:watch":"onchange 'src/**' -- pm-exec run test:unit","clean":"rimraf lib"},"dependencies":{"@types/mdast":"^3.0.3","@types/unist":"^2.0.3"},"devDependencies":{"@istanbuljs/nyc-config-typescript":"1.0.1","@types/chai":"4.2.11","@types/chai-as-promised":"7.1.2","@types/mocha":"7.0.2","@types/node":"13.9.3","@typescript-eslint/eslint-plugin":"2.25.0","@typescript-eslint/parser":"2.25.0","chai":"4.2.0","chai-as-promised":"7.1.1","cross-env":"7.0.2","depcheck":"0.9.2","eslint":"6.8.0","eslint-config-prettier":"6.10.1","eslint-plugin-import":"2.20.1","eslint-plugin-jsdoc":"22.1.0","eslint-plugin-node":"11.0.0","eslint-plugin-prettier":"3.1.2","mocha":"7.1.1","nyc":"15.0.0","onchange":"6.1.0","pm-exec":"1.0.0","prettier":"2.0.2","remark-frontmatter":"1.3.3","remark-parse":"7.0.2","remark-stringify":"7.0.4","rimraf":"3.0.2","source-map-support":"0.5.16","ts-node":"8.8.1","typescript":"3.8.3","unified":"8.4.2"},"peerDependencies":{},"engines":{"node":">=10.0.0"},"gitHead":"198e1c15ef1b82d077785ab2fce6178da513ef53","_id":"ts-mdast@1.0.0","_nodeVersion":"12.14.0","_npmVersion":"6.13.4","dist":{"integrity":"sha512-FmT5GbMU629/ty64741v7TdO8jm5xW09okr2VNExkLuRk5ngjKIDdn/woTB8lDtcgCMRS8lUNubImen0MkdF6g==","shasum":"62c1b5cb0c63dcab044f7f998f280700d504b57e","tarball":"https://registry.npmjs.org/ts-mdast/-/ts-mdast-1.0.0.tgz","fileCount":161,"unpackedSize":112060,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeemH7CRA9TVsSAnZWagAAIiMP/RX8hCtsx+f2ZZABIc6R\nYg/hOjqsbBOpxVSghwOtAiwQO+z1VV79AOYQtVx4NG5iGvihWGiZEWwxqdgu\nZp11spQoirmqOSGuQvjCdldrwp65NEweWgUzuFjyk9uGuPUZxbw/8S6DLO4R\nWIAIfGIfIDWx/aSj4zKD9j7/1NC/vfHZCC9f9UXVLq2bmnmabkrh6vdKubpp\nubyOfPjR3SgB1OIl0smXbnasi+ZDM2ReEAoJmwPNJOHP4xV6W4dVbOQ7Omvp\nnCqfTjTIj2YVVOwsZ3lggKy9mvZsWFgfaqRqZD1P7dyMSfkG0BCp8d3JV4Xn\nkiH9zJ8eLEPJVigQ1jXOIfFpV/IUs32ddt2uKg+SmMwemueACUiDpnMS0Pwp\n2bsHrx62cHxWggQlBiBXyZ1vI2qkVGeiNbhFkvT6rvM9GlYAFT2BRYcFgjBi\nZ9gGkR0Q5IWMD/eIp72aLiFFEXxHKB6RJ8lHblQ/zoNyZKdCZUNnb+zk2HDN\nnfG6DDKLePAmAUjmZNXDqA6GoRbZSRBE7Ck+lStax0ex6ylKeKyR+jo4MWAg\nv4GtjTg/PXneUD6ngOin3EmXLvAkctDwmgoe2qfJoLi/bFIvQ824rnuI8zx8\nBqTqRuJ6IC1uiONBGaNdGtuG9un50ZVH4CEiP295MQB1sYATKrHUwnvOFmxf\n8yCV\r\n=697j\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCW9X/bfDRtoxwhBVOCEUkQDK0v9jlFDvYLz8PNkY43IAIgO0wL8idyJtvpcSkZ9Iu/fX5GUrWrJa8zOlL/z/4xtOg="}]},"maintainers":[{"name":"sveyret","email":"sveyret@gmail.com"}],"_npmUser":{"name":"sveyret","email":"sveyret@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ts-mdast_1.0.0_1585078778565_0.312689335965215"},"_hasShrinkwrap":false}},"time":{"created":"2020-03-23T16:40:04.766Z","0.1.0":"2020-03-23T16:40:05.011Z","modified":"2022-05-22T07:26:39.477Z","1.0.0":"2020-03-24T19:39:38.680Z"},"maintainers":[{"name":"sveyret","email":"sveyret@gmail.com"}],"description":"Typescript utilities for Markdown Abstract Syntax Tree","homepage":"https://github.com/slune-org/ts-mdast#readme","keywords":["markdown","abstract syntax tree","syntax tree","mdast","typescript","create","type guard","guard"],"repository":{"type":"git","url":"git+https://github.com/slune-org/ts-mdast.git"},"author":{"name":"Slune"},"bugs":{"url":"https://github.com/slune-org/ts-mdast/issues"},"license":"MIT","readme":"[![npm package](https://badge.fury.io/js/ts-mdast.svg)](https://www.npmjs.com/package/ts-mdast)\n[![License](https://img.shields.io/github/license/slune-org/ts-mdast.svg)](https://github.com/slune-org/ts-mdast/blob/master/LICENSE)\n[![Build Status](https://travis-ci.org/slune-org/ts-mdast.svg?branch=master)](https://travis-ci.org/slune-org/ts-mdast)\n[![Coverage Status](https://coveralls.io/repos/github/slune-org/ts-mdast/badge.svg?branch=master)](https://coveralls.io/github/slune-org/ts-mdast?branch=master)\n[![Issues](https://img.shields.io/github/issues/slune-org/ts-mdast.svg)](https://github.com/slune-org/ts-mdast/issues)\n\n# ts-mdast - Typescript utilities for Markdown Abstract Syntax Tree\n\nThis package provides utilities to work with `Markdown` abstract syntax tree (_MDAST_). It contains:\n\n- functions to create the different node types (also useful in pure _Javascript_);\n- type guard and assertion functions to ensure the node is of expected type (especially useful with _Typescript_).\n\nThis 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.\n\n# Language/langue\n\nDocuments, messages, code (including variable names and comments), are in English.\n\nAnyway, because Slune is French firm, all documents and important messages must also be provided in French. Other translations are welcome.\n\n:fr: Une version française de ce document se trouve [ici](doc/fr/README.md).\n\n# Installation\n\nInstallation is done using `npm install` command:\n\n```bash\n$ npm install --save ts-mdast\n```\n\n# Usage\n\nFor each _NodeType_ node type, the package contains :\n\n- an `assertNodeType(node: Node)` function raising an exception if `node` is not of type *NodeType* ;\n- an `isNodeType(node: Node)` function returning `true` if `node` is of type *NodeType* ;\n- a `createNodeType(...)` function creating a node of type _NodeType_.\n\nThe first two functions are understood by _Typescript_ which is after able to control the node type in an appropriate way.\n\nThe creation function is used this as following:\n\n    createNodeType(mandatory1, mandatory2 [, optional1 [, optional2 [, optional3]] | {optional1, optional2, optional3}] [, children])\n\nwhere `mandatory_` represent the mandatory parameters, `optional_` the optional parameters and `children` an array with child nodes. Following calls are therefore possible:\n\n```typescript\ncreateNodeType(mandatory1, mandatory2, optional1, [child1, child2])\ncreateNodeType(mandatory1, mandatory2, optional1, optional2)\ncreateNodeType(mandatory1, mandatory2, { optional1, optional3 })\ncreateNodeType(mandatory1, mandatory2, { optional2, optional3 }, [child1, child2])\ncreateNodeType(mandatory1, mandatory2, [child1, child2])\n```\n\nThe array containing children is directly used in the node and can therefore be modified after node creation:\n\n```typescript\nconst children: Content[] = []\ncreateNodeType(mandatory1, mandatory2, children)\nchildren.push(createNodeType(mandatory1, mandatory2))\n```\n\n**Notes:**\n\n- The `createNodeType(...)` function only exists for concrete nodes (not on `Content` nor `BlockContent` for example).\n- All node types do not have mandatory parameters, optional parameters or child nodes.\n\n## Nodes\n\n### Parent\n\nReference: [Parent](https://github.com/syntax-tree/mdast#parent)\n\nType assertion:\n\n```typescript\nfunction assertParent(node: Node): asserts node is Parent\n```\n\nType guard:\n\n```typescript\nfunction isParent(node: Node): node is Parent\n```\n\n### Literal\n\nReference: [Literal](https://github.com/syntax-tree/mdast#literal)\n\nType assertion:\n\n```typescript\nfunction assertLiteral(node: Node): asserts node is Literal\n```\n\nType guard:\n\n```typescript\nfunction isLiteral(node: Node): node is Literal\n```\n\n### Content\n\nReference: [Content](https://github.com/syntax-tree/mdast#content)\n\nType assertion:\n\n```typescript\nfunction assertContent(node: Node): asserts node is Content\n```\n\nType guard:\n\n```typescript\nfunction isContent(node: Node): node is Content\n```\n\n### TopLevelContent\n\nReference: [TopLevelContent](https://github.com/syntax-tree/mdast#toplevelcontent)\n\nType assertion:\n\n```typescript\nfunction assertTopLevelContent(node: Node): asserts node is TopLevelContent\n```\n\nType guard:\n\n```typescript\nfunction isTopLevelContent(node: Node): node is TopLevelContent\n```\n\n### BlockContent\n\nReference: [BlockContent](https://github.com/syntax-tree/mdast#blockcontent)\n\nType assertion:\n\n```typescript\nfunction assertBlockContent(node: Node): asserts node is BlockContent\n```\n\nType guard:\n\n```typescript\nfunction isBlockContent(node: Node): node is BlockContent\n```\n\n### FrontmatterContent\n\nReference: [FrontmatterContent](https://github.com/syntax-tree/mdast#frontmattercontent)\n\nType assertion:\n\n```typescript\nfunction assertFrontmatterContent(node: Node): asserts node is FrontmatterContent\n```\n\nType guard:\n\n```typescript\nfunction isFrontmatterContent(node: Node): node is FrontmatterContent\n```\n\n### DefinitionContent\n\nReference: [DefinitionContent](https://github.com/syntax-tree/mdast#definitioncontent)\n\nType assertion:\n\n```typescript\nfunction assertDefinitionContent(node: Node): asserts node is DefinitionContent\n```\n\nType guard:\n\n```typescript\nfunction isDefinitionContent(node: Node): node is DefinitionContent\n```\n\n### ListContent\n\nReference: [ListContent](https://github.com/syntax-tree/mdast#listcontent)\n\nType assertion:\n\n```typescript\nfunction assertListContent(node: Node): asserts node is ListContent\n```\n\nType guard:\n\n```typescript\nfunction isListContent(node: Node): node is ListContent\n```\n\n### TableContent\n\nReference: [TableContent](https://github.com/syntax-tree/mdast#tablecontent)\n\nType assertion:\n\n```typescript\nfunction assertTableContent(node: Node): asserts node is TableContent\n```\n\nType guard:\n\n```typescript\nfunction isTableContent(node: Node): node is TableContent\n```\n\n### RowContent\n\nReference: [RowContent](https://github.com/syntax-tree/mdast#rowcontent)\n\nType assertion:\n\n```typescript\nfunction assertRowContent(node: Node): asserts node is RowContent\n```\n\nType guard:\n\n```typescript\nfunction isRowContent(node: Node): node is RowContent\n```\n\n### PhrasingContent\n\nReference: [PhrasingContent](https://github.com/syntax-tree/mdast#phrasingcontent)\n\nType assertion:\n\n```typescript\nfunction assertPhrasingContent(node: Node): asserts node is PhrasingContent\n```\n\nType guard:\n\n```typescript\nfunction isPhrasingContent(node: Node): node is PhrasingContent\n```\n\n### StaticPhrasingContent\n\nReference: [StaticPhrasingContent](https://github.com/syntax-tree/mdast#staticphrasingcontent)\n\nType assertion:\n\n```typescript\nfunction assertStaticPhrasingContent(node: Node): asserts node is StaticPhrasingContent\n```\n\nType guard:\n\n```typescript\nfunction isStaticPhrasingContent(node: Node): node is StaticPhrasingContent\n```\n\n### Root\n\nReference: [Root](https://github.com/syntax-tree/mdast#root)\n\nType assertion:\n\n```typescript\nfunction assertRoot(node: Node): asserts node is Root\n```\n\nType guard:\n\n```typescript\nfunction isRoot(node: Node): node is Root\n```\n\nCreation:\n\n```typescript\nfunction createRoot(children?: Content[]): Root\n```\n\n### Paragraph\n\nReference: [Paragraph](https://github.com/syntax-tree/mdast#paragraph)\n\nType assertion:\n\n```typescript\nfunction assertParagraph(node: Node): asserts node is Paragraph\n```\n\nType guard:\n\n```typescript\nfunction isParagraph(node: Node): node is Paragraph\n```\n\nCreation:\n\n```typescript\nfunction createParagraph(children?: PhrasingContent[]): Paragraph\n```\n\n### Heading\n\nReference: [Heading](https://github.com/syntax-tree/mdast#heading)\n\nType assertion:\n\n```typescript\nfunction assertHeading(node: Node): asserts node is Heading\n```\n\nType guard:\n\n```typescript\nfunction isHeading(node: Node): node is Heading\n```\n\nCreation:\n\n```typescript\nfunction createHeading(depth: 1 | 2 | 3 | 4 | 5 | 6, children?: PhrasingContent[])\n```\n\n### ThematicBreak\n\nReference: [ThematicBreak](https://github.com/syntax-tree/mdast#thematicbreak)\n\nType assertion:\n\n```typescript\nfunction assertThematicBreak(node: Node): asserts node is ThematicBreak\n```\n\nType guard:\n\n```typescript\nfunction isThematicBreak(node: Node): node is ThematicBreak\n```\n\nCreation:\n\n```typescript\nfunction createThematicBreak(): ThematicBreak\n```\n\n### Blockquote\n\nReference: [Blockquote](https://github.com/syntax-tree/mdast#blockquote)\n\nType assertion:\n\n```typescript\nfunction assertBlockquote(node: Node): asserts node is Blockquote\n```\n\nType guard:\n\n```typescript\nfunction isBlockquote(node: Node): node is Blockquote\n```\n\nCreation:\n\n```typescript\nfunction createBlockquote(children?: BlockContent[]): Blockquote\n```\n\n### List\n\nReference: [List](https://github.com/syntax-tree/mdast#list)\n\nType assertion:\n\n```typescript\nfunction assertList(node: Node): asserts node is List\n```\n\nType guard:\n\n```typescript\nfunction isList(node: Node): node is List\n```\n\nCreation:\n\n```typescript\nfunction createList(ordered: boolean, start: number, spread: boolean, children?: ListContent[]): List\nfunction createList(ordered: boolean, start: number, children?: ListContent[]): List\nfunction createList(ordered: boolean, children?: ListContent[]): List\nfunction createList(children?: ListContent[]): List\nfunction createList(\n  options: { ordered?: boolean; start?: number; spread?: boolean },\n  children?: ListContent[]\n): List\n```\n\n### ListItem\n\nReference: [ListItem](https://github.com/syntax-tree/mdast#listitem)\n\nType assertion:\n\n```typescript\nfunction assertListItem(node: Node): asserts node is ListItem\n```\n\nType guard:\n\n```typescript\nfunction isListItem(node: Node): node is ListItem\n```\n\nCreation:\n\n```typescript\nfunction createListItem(checked: boolean, spread: boolean, children?: BlockContent[]): ListItem\nfunction createListItem(checked: boolean, children?: BlockContent[]): ListItem\nfunction createListItem(children?: BlockContent[]): ListItem\nfunction createListItem(\n  options: { checked?: boolean; spread?: boolean },\n  children?: BlockContent[]\n): ListItem\n```\n\n### Table\n\nReference: [Table](https://github.com/syntax-tree/mdast#table)\n\nType assertion:\n\n```typescript\nfunction assertTable(node: Node): asserts node is Table\n```\n\nType guard:\n\n```typescript\nfunction isTable(node: Node): node is Table\n```\n\nCreation:\n\n```typescript\nfunction createTable(align: AlignType[], children?: TableContent[]): Table\nfunction createTable(children?: TableContent[]): Table\nfunction createTable(options: { align?: AlignType[] }, children?: TableContent[]): Table\n```\n\n### TableRow\n\nReference: [TableRow](https://github.com/syntax-tree/mdast#tablerow)\n\nType assertion:\n\n```typescript\nfunction assertTableRow(node: Node): asserts node is TableRow\n```\n\nType guard:\n\n```typescript\nfunction isTableRow(node: Node): node is TableRow\n```\n\nCreation:\n\n```typescript\nfunction createTableRow(children?: RowContent[]): TableRow\n```\n\n### TableCell\n\nReference: [TableCell](https://github.com/syntax-tree/mdast#tablecell)\n\nType assertion:\n\n```typescript\nfunction assertTableCell(node: Node): asserts node is TableCell\n```\n\nType guard:\n\n```typescript\nfunction isTableCell(node: Node): node is TableCell\n```\n\nCreation:\n\n```typescript\nfunction createTableCell(children?: PhrasingContent[]): TableCell\n```\n\n### HTML\n\nReference: [HTML](https://github.com/syntax-tree/mdast#html)\n\nType assertion:\n\n```typescript\nfunction assertHTML(node: Node): asserts node is HTML\n```\n\nType guard:\n\n```typescript\nfunction isHTML(node: Node): node is HTML\n```\n\nCreation:\n\n```typescript\nfunction createHTML(value: string): HTML\n```\n\n### Code\n\nReference: [Code](https://github.com/syntax-tree/mdast#code)\n\nType assertion:\n\n```typescript\nfunction assertCode(node: Node): asserts node is Code\n```\n\nType guard:\n\n```typescript\nfunction isCode(node: Node): node is Code\n```\n\nCreation:\n\n```typescript\nfunction createCode(value: string, lang?: string, meta?: string): Code\nfunction createCode(value: string, options: { lang?: string; meta?: string }): Code\n```\n\n### YAML\n\nReference: [YAML](https://github.com/syntax-tree/mdast#yaml)\n\nType assertion:\n\n```typescript\nfunction assertYAML(node: Node): asserts node is YAML\n```\n\nType guard:\n\n```typescript\nfunction isYAML(node: Node): node is YAML\n```\n\nCreation:\n\n```typescript\nfunction createYAML(value: string): YAML\n```\n\n### Definition\n\nReference: [Definition](https://github.com/syntax-tree/mdast#definition)\n\nType assertion:\n\n```typescript\nfunction assertDefinition(node: Node): asserts node is Definition\n```\n\nType guard:\n\n```typescript\nfunction isDefinition(node: Node): node is Definition\n```\n\nCreation:\n\n```typescript\nfunction createDefinition(identifier: string, url: string, label?: string, title?: string): Definition\nfunction createDefinition(\n  identifier: string,\n  url: string,\n  options: { label?: string; title?: string }\n): Definition\n```\n\n### FootnoteDefinition\n\nReference: [FootnoteDefinition](https://github.com/syntax-tree/mdast#footnotedefinition)\n\nType assertion:\n\n```typescript\nfunction assertFootnoteDefinition(node: Node): asserts node is FootnoteDefinition\n```\n\nType guard:\n\n```typescript\nfunction isFootnoteDefinition(node: Node): node is FootnoteDefinition\n```\n\nCreation:\n\n```typescript\nfunction createFootnoteDefinition(\n  identifier: string,\n  label: string,\n  children?: BlockContent[]\n): FootnoteDefinition\nfunction createFootnoteDefinition(identifier: string, children?: BlockContent[]): FootnoteDefinition\nfunction createFootnoteDefinition(\n  identifier: string,\n  options: { label?: string },\n  children?: BlockContent[]\n): FootnoteDefinition\n```\n\n### Text\n\nReference: [Text](https://github.com/syntax-tree/mdast#text)\n\nType assertion:\n\n```typescript\nfunction assertText(node: Node): asserts node is Text\n```\n\nType guard:\n\n```typescript\nfunction isText(node: Node): node is Text\n```\n\nCreation:\n\n```typescript\nfunction createText(value: string): Text\n```\n\n### Emphasis\n\nReference: [Emphasis](https://github.com/syntax-tree/mdast#emphasis)\n\nType assertion:\n\n```typescript\nfunction assertEmphasis(node: Node): asserts node is Emphasis\n```\n\nType guard:\n\n```typescript\nfunction isEmphasis(node: Node): node is Emphasis\n```\n\nCreation:\n\n```typescript\nfunction createEmphasis(children?: PhrasingContent[]): Emphasis\n```\n\n### Strong\n\nReference: [Strong](https://github.com/syntax-tree/mdast#strong)\n\nType assertion:\n\n```typescript\nfunction assertStrong(node: Node): asserts node is Strong\n```\n\nType guard:\n\n```typescript\nfunction isStrong(node: Node): node is Strong\n```\n\nCreation:\n\n```typescript\nfunction createStrong(children?: PhrasingContent[]): Strong\n```\n\n### Delete\n\nReference: [Delete](https://github.com/syntax-tree/mdast#delete)\n\nType assertion:\n\n```typescript\nfunction assertDelete(node: Node): asserts node is Delete\n```\n\nType guard:\n\n```typescript\nfunction isDelete(node: Node): node is Delete\n```\n\nCreation:\n\n```typescript\nfunction createDelete(children?: PhrasingContent[]): Delete\n```\n\n### InlineCode\n\nReference: [InlineCode](https://github.com/syntax-tree/mdast#inlinecode)\n\nType assertion:\n\n```typescript\nfunction assertInlineCode(node: Node): asserts node is InlineCode\n```\n\nType guard:\n\n```typescript\nfunction isInlineCode(node: Node): node is InlineCode\n```\n\nCreation:\n\n```typescript\nfunction createInlineCode(value: string): InlineCode\n```\n\n### Break\n\nReference: [Break](https://github.com/syntax-tree/mdast#break)\n\nType assertion:\n\n```typescript\nfunction assertBreak(node: Node): asserts node is Break\n```\n\nType guard:\n\n```typescript\nfunction isBreak(node: Node): node is Break\n```\n\nCreation:\n\n```typescript\nfunction createBreak(): Break\n```\n\n### Link\n\nReference: [Link](https://github.com/syntax-tree/mdast#link)\n\nType assertion:\n\n```typescript\nfunction assertLink(node: Node): asserts node is Link\n```\n\nType guard:\n\n```typescript\nfunction isLink(node: Node): node is Link\n```\n\nCreation:\n\n```typescript\nfunction createLink(url: string, title: string, children?: StaticPhrasingContent[]): Link\nfunction createLink(url: string, children?: StaticPhrasingContent[]): Link\nfunction createLink(url: string, options: { title?: string }, children?: StaticPhrasingContent[]): Link\n```\n\n### Image\n\nReference: [Image](https://github.com/syntax-tree/mdast#image)\n\nType assertion:\n\n```typescript\nfunction assertImage(node: Node): asserts node is Image\n```\n\nType guard:\n\n```typescript\nfunction isImage(node: Node): node is Image\n```\n\nCreation:\n\n```typescript\nfunction createImage(url: string, alt?: string, title?: string): Image\nfunction createImage(url: string, options: { alt?: string; title?: string }): Image\n```\n\n### LinkReference\n\nReference: [LinkReference](https://github.com/syntax-tree/mdast#linkreference)\n\nType assertion:\n\n```typescript\nfunction assertLinkReference(node: Node): asserts node is LinkReference\n```\n\nType guard:\n\n```typescript\nfunction isLinkReference(node: Node): node is LinkReference\n```\n\nCreation:\n\n```typescript\nfunction createLinkReference(\n  identifier: string,\n  referenceType: ReferenceType,\n  label: string,\n  children?: StaticPhrasingContent[]\n): LinkReference\nfunction createLinkReference(\n  identifier: string,\n  referenceType: ReferenceType,\n  children?: StaticPhrasingContent[]\n): LinkReference\nfunction createLinkReference(\n  identifier: string,\n  referenceType: ReferenceType,\n  options: { label?: string },\n  children?: StaticPhrasingContent[]\n): LinkReference\n```\n\n### ImageReference\n\nReference: [ImageReference](https://github.com/syntax-tree/mdast#imagereference)\n\nType assertion:\n\n```typescript\nfunction assertImageReference(node: Node): asserts node is ImageReference\n```\n\nType guard:\n\n```typescript\nfunction isImageReference(node: Node): node is ImageReference\n```\n\nCreation:\n\n```typescript\nfunction createImageReference(\n  identifier: string,\n  referenceType: ReferenceType,\n  alt?: string,\n  label?: string\n): ImageReference\nfunction createImageReference(\n  identifier: string,\n  referenceType: ReferenceType,\n  options: { alt?: string; label?: string }\n): ImageReference\n```\n\n### Footnote\n\nReference: [Footnote](https://github.com/syntax-tree/mdast#footnote)\n\nType assertion:\n\n```typescript\nfunction assertFootnote(node: Node): asserts node is Footnote\n```\n\nType guard:\n\n```typescript\nfunction isFootnote(node: Node): node is Footnote\n```\n\nCreation:\n\n```typescript\nfunction createFootnote(children?: PhrasingContent[]): Footnote\n```\n\n### FootnoteReference\n\nReference: [FootnoteReference](https://github.com/syntax-tree/mdast#footnotereference)\n\nType assertion:\n\n```typescript\nfunction assertFootnoteReference(node: Node): asserts node is FootnoteReference\n```\n\nType guard:\n\n```typescript\nfunction isFootnoteReference(node: Node): node is FootnoteReference\n```\n\nCreation:\n\n```typescript\nfunction createFootnoteReference(identifier: string, label?: string): FootnoteReference\nfunction createFootnoteReference(identifier: string, options: { label?: string }): FootnoteReference\n```\n\n# Contributing\n\nEven though we cannot guarantee a response time, please feel free to file an issue if you have any question or problem using the package.\n\n_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.\n","readmeFilename":"README.md"}