@textlint/ast-node-types

  • Version 13.3.2
  • Published
  • 129 kB
  • No dependencies
  • MIT license

Install

npm i @textlint/ast-node-types
yarn add @textlint/ast-node-types
pnpm add @textlint/ast-node-types

Overview

textlint AST node type definition.

Index

Interfaces

interface TxtBlockQuoteNode

interface TxtBlockQuoteNode extends TxtParentNode {}

    property children

    children: BlockContent[];

      property type

      type: 'BlockQuote';

        interface TxtBreakNode

        interface TxtBreakNode extends TxtNode {}

          property type

          type: 'Break';

            interface TxtCodeBlockNode

            interface TxtCodeBlockNode extends TxtTextNode {}

              property lang

              lang?: string | null | undefined;

                property meta

                meta?: string | null | undefined;

                  property type

                  type: 'CodeBlock';

                    interface TxtCodeNode

                    interface TxtCodeNode extends TxtTextNode {}

                      property type

                      type: 'Code';

                        interface TxtCommentNode

                        interface TxtCommentNode extends TxtTextNode {}

                          property type

                          type: 'Comment';

                            interface TxtDeleteNode

                            interface TxtDeleteNode extends TxtParentNode {}

                              property children

                              children: PhrasingContent[];

                                property type

                                type: 'Delete';

                                  interface TxtDocumentNode

                                  interface TxtDocumentNode extends TxtParentNode {}

                                    property type

                                    type: 'Document';

                                      interface TxtEmphasisNode

                                      interface TxtEmphasisNode extends TxtParentNode {}

                                        property children

                                        children: PhrasingContent[];

                                          property type

                                          type: 'Emphasis';

                                            interface TxtHeaderNode

                                            interface TxtHeaderNode extends TxtParentNode {}

                                              property children

                                              children: PhrasingContent[];

                                                property depth

                                                depth: 1 | 2 | 3 | 4 | 5 | 6;

                                                  property type

                                                  type: 'Header';

                                                    interface TxtHorizontalRuleNode

                                                    interface TxtHorizontalRuleNode extends TxtNode {}

                                                      property type

                                                      type: 'HorizontalRule';

                                                        interface TxtHtmlNode

                                                        interface TxtHtmlNode extends TxtTextNode {}

                                                          property type

                                                          type: 'Html';

                                                            interface TxtImageNode

                                                            interface TxtImageNode extends TxtNode, TxtResource, TxtAlternative {}

                                                              property type

                                                              type: 'Image';

                                                                interface TxtLinkNode

                                                                interface TxtLinkNode extends TxtParentNode, TxtResource {}

                                                                  property children

                                                                  children: StaticPhrasingContent[];

                                                                    property type

                                                                    type: 'Link';

                                                                      interface TxtListItemNode

                                                                      interface TxtListItemNode extends TxtParentNode {}

                                                                        property checked

                                                                        checked?: boolean | null | undefined;

                                                                          property children

                                                                          children: BlockContent[];

                                                                            property spread

                                                                            spread?: boolean | null | undefined;

                                                                              property type

                                                                              type: 'ListItem';

                                                                                interface TxtListNode

                                                                                interface TxtListNode extends TxtParentNode {}

                                                                                  property children

                                                                                  children: ListContent[];

                                                                                    property ordered

                                                                                    ordered?: boolean | null | undefined;

                                                                                      property spread

                                                                                      spread?: boolean | null | undefined;

                                                                                        property start

                                                                                        start?: number | null | undefined;

                                                                                          property type

                                                                                          type: 'List';

                                                                                            interface TxtNode

                                                                                            interface TxtNode {}
                                                                                            • TxtNode is abstract interface of AST Node. Probably, Real TxtNode implementation has more properties.

                                                                                            property loc

                                                                                            loc: TxtNodeLocation;

                                                                                              property parent

                                                                                              parent?: TxtParentNode;

                                                                                                property range

                                                                                                range: TxtNodeRange;

                                                                                                  property raw

                                                                                                  raw: string;

                                                                                                    property type

                                                                                                    type: TxtNodeType;

                                                                                                      index signature

                                                                                                      [index: string]: any;

                                                                                                        interface TxtParagraphNode

                                                                                                        interface TxtParagraphNode extends TxtParentNode {}

                                                                                                          property children

                                                                                                          children: PhrasingContent[];

                                                                                                            property type

                                                                                                            type: 'Paragraph';

                                                                                                              interface TxtParentNode

                                                                                                              interface TxtParentNode extends TxtNode {}
                                                                                                              • Parent Node. Parent Node has children that are consist of TxtParentNode or TxtTextNode

                                                                                                              property children

                                                                                                              children: Content[];

                                                                                                                interface TxtStrNode

                                                                                                                interface TxtStrNode extends TxtTextNode {}

                                                                                                                  property type

                                                                                                                  type: 'Str';

                                                                                                                    interface TxtStrongNode

                                                                                                                    interface TxtStrongNode extends TxtParentNode {}

                                                                                                                      property children

                                                                                                                      children: PhrasingContent[];

                                                                                                                        property type

                                                                                                                        type: 'Strong';

                                                                                                                          interface TxtTableCellNode

                                                                                                                          interface TxtTableCellNode extends TxtParentNode {}

                                                                                                                            property children

                                                                                                                            children: PhrasingContent[];

                                                                                                                              property type

                                                                                                                              type: 'TableCell';

                                                                                                                                interface TxtTableNode

                                                                                                                                interface TxtTableNode extends TxtParentNode {}

                                                                                                                                  property align

                                                                                                                                  align?: AlignType[] | null | undefined;

                                                                                                                                    property children

                                                                                                                                    children: TableContent[];

                                                                                                                                      property type

                                                                                                                                      type: 'Table';

                                                                                                                                        interface TxtTableRowNode

                                                                                                                                        interface TxtTableRowNode extends TxtParentNode {}

                                                                                                                                          property children

                                                                                                                                          children: RowContent[];

                                                                                                                                            property type

                                                                                                                                            type: 'TableRow';

                                                                                                                                              interface TxtTextNode

                                                                                                                                              interface TxtTextNode extends TxtNode {}
                                                                                                                                              • Text Node. Text Node has inline value. For example, Str Node is an TxtTextNode.

                                                                                                                                              property value

                                                                                                                                              value: string;

                                                                                                                                                Enums

                                                                                                                                                enum ASTNodeTypes

                                                                                                                                                enum ASTNodeTypes {
                                                                                                                                                Document = 'Document',
                                                                                                                                                DocumentExit = 'Document:exit',
                                                                                                                                                Paragraph = 'Paragraph',
                                                                                                                                                ParagraphExit = 'Paragraph:exit',
                                                                                                                                                BlockQuote = 'BlockQuote',
                                                                                                                                                BlockQuoteExit = 'BlockQuote:exit',
                                                                                                                                                ListItem = 'ListItem',
                                                                                                                                                ListItemExit = 'ListItem:exit',
                                                                                                                                                List = 'List',
                                                                                                                                                ListExit = 'List:exit',
                                                                                                                                                Header = 'Header',
                                                                                                                                                HeaderExit = 'Header:exit',
                                                                                                                                                CodeBlock = 'CodeBlock',
                                                                                                                                                CodeBlockExit = 'CodeBlock:exit',
                                                                                                                                                HtmlBlock = 'HtmlBlock',
                                                                                                                                                HtmlBlockExit = 'HtmlBlock:exit',
                                                                                                                                                HorizontalRule = 'HorizontalRule',
                                                                                                                                                HorizontalRuleExit = 'HorizontalRule:exit',
                                                                                                                                                Comment = 'Comment',
                                                                                                                                                CommentExit = 'Comment:exit',
                                                                                                                                                ReferenceDef = 'ReferenceDef',
                                                                                                                                                ReferenceDefExit = 'ReferenceDef:exit',
                                                                                                                                                Str = 'Str',
                                                                                                                                                StrExit = 'Str:exit',
                                                                                                                                                Break = 'Break',
                                                                                                                                                BreakExit = 'Break:exit',
                                                                                                                                                Emphasis = 'Emphasis',
                                                                                                                                                EmphasisExit = 'Emphasis:exit',
                                                                                                                                                Strong = 'Strong',
                                                                                                                                                StrongExit = 'Strong:exit',
                                                                                                                                                Html = 'Html',
                                                                                                                                                HtmlExit = 'Html:exit',
                                                                                                                                                Link = 'Link',
                                                                                                                                                LinkExit = 'Link:exit',
                                                                                                                                                Image = 'Image',
                                                                                                                                                ImageExit = 'Image:exit',
                                                                                                                                                Code = 'Code',
                                                                                                                                                CodeExit = 'Code:exit',
                                                                                                                                                Delete = 'Delete',
                                                                                                                                                DeleteExit = 'Delete:exit',
                                                                                                                                                Table = 'Table',
                                                                                                                                                TableExit = 'Table:exit',
                                                                                                                                                TableRow = 'TableRow',
                                                                                                                                                TableRowExit = 'TableRow:exit',
                                                                                                                                                TableCell = 'TableCell',
                                                                                                                                                TableCellExit = 'TableCell:exit',
                                                                                                                                                }
                                                                                                                                                • ASTNodeTypes is a list of ASTNode type.

                                                                                                                                                member BlockQuote

                                                                                                                                                BlockQuote = 'BlockQuote'

                                                                                                                                                  member BlockQuoteExit

                                                                                                                                                  BlockQuoteExit = 'BlockQuote:exit'

                                                                                                                                                    member Break

                                                                                                                                                    Break = 'Break'

                                                                                                                                                      member BreakExit

                                                                                                                                                      BreakExit = 'Break:exit'

                                                                                                                                                        member Code

                                                                                                                                                        Code = 'Code'

                                                                                                                                                          member CodeBlock

                                                                                                                                                          CodeBlock = 'CodeBlock'

                                                                                                                                                            member CodeBlockExit

                                                                                                                                                            CodeBlockExit = 'CodeBlock:exit'

                                                                                                                                                              member CodeExit

                                                                                                                                                              CodeExit = 'Code:exit'

                                                                                                                                                                member Comment

                                                                                                                                                                Comment = 'Comment'

                                                                                                                                                                  member CommentExit

                                                                                                                                                                  CommentExit = 'Comment:exit'

                                                                                                                                                                    member Delete

                                                                                                                                                                    Delete = 'Delete'

                                                                                                                                                                      member DeleteExit

                                                                                                                                                                      DeleteExit = 'Delete:exit'

                                                                                                                                                                        member Document

                                                                                                                                                                        Document = 'Document'

                                                                                                                                                                          member DocumentExit

                                                                                                                                                                          DocumentExit = 'Document:exit'

                                                                                                                                                                            member Emphasis

                                                                                                                                                                            Emphasis = 'Emphasis'

                                                                                                                                                                              member EmphasisExit

                                                                                                                                                                              EmphasisExit = 'Emphasis:exit'

                                                                                                                                                                                member Header

                                                                                                                                                                                Header = 'Header'

                                                                                                                                                                                  member HeaderExit

                                                                                                                                                                                  HeaderExit = 'Header:exit'

                                                                                                                                                                                    member HorizontalRule

                                                                                                                                                                                    HorizontalRule = 'HorizontalRule'

                                                                                                                                                                                      member HorizontalRuleExit

                                                                                                                                                                                      HorizontalRuleExit = 'HorizontalRule:exit'

                                                                                                                                                                                        member Html

                                                                                                                                                                                        Html = 'Html'

                                                                                                                                                                                          member HtmlBlock

                                                                                                                                                                                          HtmlBlock = 'HtmlBlock'
                                                                                                                                                                                          • Deprecated

                                                                                                                                                                                            use Html instead of it

                                                                                                                                                                                          member HtmlBlockExit

                                                                                                                                                                                          HtmlBlockExit = 'HtmlBlock:exit'

                                                                                                                                                                                            member HtmlExit

                                                                                                                                                                                            HtmlExit = 'Html:exit'

                                                                                                                                                                                              member Image

                                                                                                                                                                                              Image = 'Image'

                                                                                                                                                                                                member ImageExit

                                                                                                                                                                                                ImageExit = 'Image:exit'
                                                                                                                                                                                                  Link = 'Link'

                                                                                                                                                                                                    member LinkExit

                                                                                                                                                                                                    LinkExit = 'Link:exit'

                                                                                                                                                                                                      member List

                                                                                                                                                                                                      List = 'List'

                                                                                                                                                                                                        member ListExit

                                                                                                                                                                                                        ListExit = 'List:exit'

                                                                                                                                                                                                          member ListItem

                                                                                                                                                                                                          ListItem = 'ListItem'

                                                                                                                                                                                                            member ListItemExit

                                                                                                                                                                                                            ListItemExit = 'ListItem:exit'

                                                                                                                                                                                                              member Paragraph

                                                                                                                                                                                                              Paragraph = 'Paragraph'

                                                                                                                                                                                                                member ParagraphExit

                                                                                                                                                                                                                ParagraphExit = 'Paragraph:exit'

                                                                                                                                                                                                                  member ReferenceDef

                                                                                                                                                                                                                  ReferenceDef = 'ReferenceDef'
                                                                                                                                                                                                                  • Deprecated

                                                                                                                                                                                                                  member ReferenceDefExit

                                                                                                                                                                                                                  ReferenceDefExit = 'ReferenceDef:exit'
                                                                                                                                                                                                                  • Deprecated

                                                                                                                                                                                                                  member Str

                                                                                                                                                                                                                  Str = 'Str'

                                                                                                                                                                                                                    member StrExit

                                                                                                                                                                                                                    StrExit = 'Str:exit'

                                                                                                                                                                                                                      member Strong

                                                                                                                                                                                                                      Strong = 'Strong'

                                                                                                                                                                                                                        member StrongExit

                                                                                                                                                                                                                        StrongExit = 'Strong:exit'

                                                                                                                                                                                                                          member Table

                                                                                                                                                                                                                          Table = 'Table'

                                                                                                                                                                                                                            member TableCell

                                                                                                                                                                                                                            TableCell = 'TableCell'

                                                                                                                                                                                                                              member TableCellExit

                                                                                                                                                                                                                              TableCellExit = 'TableCell:exit'

                                                                                                                                                                                                                                member TableExit

                                                                                                                                                                                                                                TableExit = 'Table:exit'

                                                                                                                                                                                                                                  member TableRow

                                                                                                                                                                                                                                  TableRow = 'TableRow'

                                                                                                                                                                                                                                    member TableRowExit

                                                                                                                                                                                                                                    TableRowExit = 'TableRow:exit'

                                                                                                                                                                                                                                      Type Aliases

                                                                                                                                                                                                                                      type AnyTxtNode

                                                                                                                                                                                                                                      type AnyTxtNode = TxtNode | TxtTextNode | TxtParentNode;
                                                                                                                                                                                                                                      • Any TxtNode types

                                                                                                                                                                                                                                      type TxtNodeLocation

                                                                                                                                                                                                                                      type TxtNodeLocation = {
                                                                                                                                                                                                                                      start: TxtNodePosition;
                                                                                                                                                                                                                                      end: TxtNodePosition;
                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                      • Location

                                                                                                                                                                                                                                      type TxtNodePosition

                                                                                                                                                                                                                                      type TxtNodePosition = {
                                                                                                                                                                                                                                      line: number;
                                                                                                                                                                                                                                      column: number;
                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                      • Position's line start with 1. Position's column start with 0. This is for compatibility with JavaScript AST. https://gist.github.com/azu/8866b2cb9b7a933e01fe

                                                                                                                                                                                                                                      type TxtNodeRange

                                                                                                                                                                                                                                      type TxtNodeRange = readonly [startIndex: number, endIndex: number];
                                                                                                                                                                                                                                      • Range starts with 0

                                                                                                                                                                                                                                      type TxtNodeType

                                                                                                                                                                                                                                      type TxtNodeType = keyof typeof ASTNodeTypes;
                                                                                                                                                                                                                                      • Key of ASTNodeTypes or any string For example, TxtNodeType is "Document".

                                                                                                                                                                                                                                      type TypeofTxtNode

                                                                                                                                                                                                                                      type TypeofTxtNode<T extends ASTNodeTypes | string> = T extends ASTNodeTypes.Document
                                                                                                                                                                                                                                      ? TxtDocumentNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.DocumentExit
                                                                                                                                                                                                                                      ? TxtDocumentNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.Paragraph
                                                                                                                                                                                                                                      ? TxtParagraphNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.ParagraphExit
                                                                                                                                                                                                                                      ? TxtParagraphNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.BlockQuote
                                                                                                                                                                                                                                      ? TxtBlockQuoteNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.BlockQuoteExit
                                                                                                                                                                                                                                      ? TxtBlockQuoteNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.List
                                                                                                                                                                                                                                      ? TxtListNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.ListExit
                                                                                                                                                                                                                                      ? TxtListNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.ListItem
                                                                                                                                                                                                                                      ? TxtListItemNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.ListItemExit
                                                                                                                                                                                                                                      ? TxtListItemNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.Header
                                                                                                                                                                                                                                      ? TxtHeaderNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.HeaderExit
                                                                                                                                                                                                                                      ? TxtHeaderNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.CodeBlock
                                                                                                                                                                                                                                      ? TxtCodeBlockNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.CodeBlockExit
                                                                                                                                                                                                                                      ? TxtCodeBlockNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.HtmlBlock
                                                                                                                                                                                                                                      ? TxtHtmlNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.HtmlBlockExit
                                                                                                                                                                                                                                      ? TxtHtmlNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.Link
                                                                                                                                                                                                                                      ? TxtLinkNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.LinkExit
                                                                                                                                                                                                                                      ? TxtLinkNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.Delete
                                                                                                                                                                                                                                      ? TxtDeleteNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.DeleteExit
                                                                                                                                                                                                                                      ? TxtDeleteNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.Emphasis
                                                                                                                                                                                                                                      ? TxtEmphasisNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.EmphasisExit
                                                                                                                                                                                                                                      ? TxtEmphasisNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.Strong
                                                                                                                                                                                                                                      ? TxtStrongNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.StrongExit
                                                                                                                                                                                                                                      ? TxtStrongNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.Break
                                                                                                                                                                                                                                      ? TxtBreakNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.BreakExit
                                                                                                                                                                                                                                      ? TxtBreakNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.Image
                                                                                                                                                                                                                                      ? TxtImageNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.ImageExit
                                                                                                                                                                                                                                      ? TxtImageNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.HorizontalRule
                                                                                                                                                                                                                                      ? TxtHorizontalRuleNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.HorizontalRuleExit
                                                                                                                                                                                                                                      ? TxtHorizontalRuleNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.Comment
                                                                                                                                                                                                                                      ? TxtCommentNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.CommentExit
                                                                                                                                                                                                                                      ? TxtCommentNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.Str
                                                                                                                                                                                                                                      ? TxtStrNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.StrExit
                                                                                                                                                                                                                                      ? TxtStrNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.Code
                                                                                                                                                                                                                                      ? TxtCodeNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.CodeExit
                                                                                                                                                                                                                                      ? TxtCodeNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.Html
                                                                                                                                                                                                                                      ? TxtHtmlNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.HtmlExit
                                                                                                                                                                                                                                      ? TxtHtmlNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.Table
                                                                                                                                                                                                                                      ? TxtTableNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.TableExit
                                                                                                                                                                                                                                      ? TxtTableNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.TableRow
                                                                                                                                                                                                                                      ? TxtTableRowNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.TableRowExit
                                                                                                                                                                                                                                      ? TxtTableRowNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.TableCell
                                                                                                                                                                                                                                      ? TxtTableCellNode
                                                                                                                                                                                                                                      : T extends ASTNodeTypes.TableCellExit
                                                                                                                                                                                                                                      ? TxtTableCellNode
                                                                                                                                                                                                                                      : AnyTxtNode;
                                                                                                                                                                                                                                      • Type utility for TxtNodeType Return TxtNode interface for the TxtNodeTYpe

                                                                                                                                                                                                                                        Example 1

                                                                                                                                                                                                                                        type NodeType = TxtNodeTypeOfNode<ASTNodeTypes.Document>;

                                                                                                                                                                                                                                      Package Files (4)

                                                                                                                                                                                                                                      Dependencies (0)

                                                                                                                                                                                                                                      No dependencies.

                                                                                                                                                                                                                                      Dev Dependencies (4)

                                                                                                                                                                                                                                      Peer Dependencies (0)

                                                                                                                                                                                                                                      No peer dependencies.

                                                                                                                                                                                                                                      Badge

                                                                                                                                                                                                                                      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                                                                                                                                                                      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@textlint/ast-node-types.

                                                                                                                                                                                                                                      • Markdown
                                                                                                                                                                                                                                        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@textlint/ast-node-types)
                                                                                                                                                                                                                                      • HTML
                                                                                                                                                                                                                                        <a href="https://www.jsdocs.io/package/@textlint/ast-node-types"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>