markdown-to-ast/lib/declarations/markdown-to-ast.d.ts at a604e4abbecdd5cb2bab077a14f2b2a4a64119ac · textlint/markdown-to-ast · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190

//
// Copyright © 2017-present Pouya Kary <k@karyfoundation.org>
//

declare module 'markdown-to-ast' {

    //
    // ─── PARSE FUNCTION ─────────────────────────────────────────────────────────────
    //

        export function parse ( markdown: string ): IRootNode

    //
    // ─── ROOT NODE ──────────────────────────────────────────────────────────────────
    //

        export interface IRootNode {
            type: "Document"
                | "Header"
                | "Paragraph"
                | "Str"
                | "Emphasis"
                | "Strong"
                | "Code"
                | "CodeBlock"
                | "table"
                | "tableRow"
                | "tableCell"
                | "List"
                | "ListItem"
                | "Link"
                | "Image"
                | "BlockQuote"
                | "Html"

            children: IRootNode[ ]
            loc: ILoC
            raw: string
            range: number[ ]
        }

        export interface ILoC {
            start: {
                line: number,
                column: number,
            },
            end: {
                line: number,
                column: number,
            }
        }

    //
    // ─── HEADER NODE ────────────────────────────────────────────────────────────────
    //

        export interface IHeaderNode extends IRootNode {
            type: "Header"
            depth: 1 | 2 | 3 | 4 | 5 | 6
        }

    //
    // ─── PARAGRAPH NODE ─────────────────────────────────────────────────────────────
    //

        export interface IParagraphNode extends IRootNode {
            type: "Paragraph"
        }

    //
    // ─── STRING NODE ────────────────────────────────────────────────────────────────
    //

        export interface IStrNode extends IRootNode {
            type: "Str"
            value: string
        }

    //
    // ─── CODE BLOCK ─────────────────────────────────────────────────────────────────
    //

        export interface ICodeNode extends IRootNode {
            type: "Code",
            value: string
        }

        export interface ICodeBlockNode extends IRootNode {
            type: "CodeBlock"
            lang: string | null
            value: string
        }

    //
    // ─── LINK ───────────────────────────────────────────────────────────────────────
    //

        export interface ILinkNode extends IRootNode {
            type: "Link"
            title: string | null
            link: string
        }

    //
    // ─── IMAGE ──────────────────────────────────────────────────────────────────────
    //

        export interface IImageNode extends IRootNode {
            type: "Image"
            title: string | null
            url: string
            alt: string | null
        }

    //
    // ─── EMPHASIS NODE ──────────────────────────────────────────────────────────────
    //

        export interface IEmphasisNode extends IRootNode {
            type: "Emphasis"
        }

    //
    // ─── STRONG NODE ────────────────────────────────────────────────────────────────
    //

        export interface IStrongNode extends IRootNode {
            type: "Strong"
        }

    //
    // ─── BLOCK QUOTE NODE ───────────────────────────────────────────────────────────
    //

        export interface IBlockQuote extends IRootNode {
            type: "BlockQuote"
        }

    //
    // ─── TABLE NODE ─────────────────────────────────────────────────────────────────
    //

        export type TTableAlign = "left" | "center" | "right" | null

        export interface ITableNode extends IRootNode {
            table: "Table"
            align: TTableAlign[ ]
            children: ITableRowNode[ ]
        }

        export interface ITableRowNode extends IRootNode {
            type: "tableRow"
            children: ITableCellNode[ ]
        }

        export interface ITableCellNode extends IRootNode {
            type: "tableCell"
        }

    //
    // ─── LIST NODE ──────────────────────────────────────────────────────────────────
    //

        export interface IListNode extends IRootNode {
            type: "List"
            ordered: boolean
            start: number
            loose: boolean
            children: IListItemNode[ ]
        }

        export interface IListItemNode extends IRootNode {
            type: "ListItem"
            loose: boolean
            checked: null | boolean
        }

    //
    // ─── HTML NODE ──────────────────────────────────────────────────────────────────
    //

        export interface IHtmlNode extends IRootNode {
            type: "Html"
            value: string
        }

    // ────────────────────────────────────────────────────────────────────────────────

}