summaryrefslogtreecommitdiff
path: root/node_modules/posthtml-render/dist/index.d.ts
blob: 5c054364559fdc4b0b47d88d61094cdae6ab1166 (plain)
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
import { NodeText, NodeTag } from 'posthtml-parser';

declare enum quoteStyleEnum {
    Smart = 0,
    Single = 1,
    Double = 2
}
declare enum closingSingleTagOptionEnum {
    tag = "tag",
    slash = "slash",
    default = "default",
    closeAs = "closeAs"
}
declare enum closingSingleTagTypeEnum {
    tag = "tag",
    slash = "slash",
    default = "default"
}
declare type Node = NodeText | NodeTag & {
    closeAs?: closingSingleTagTypeEnum;
};
declare type Options = {
    /**
     * Custom single tags (selfClosing).
     *
     * @default []
     */
    singleTags?: Array<string | RegExp>;
    /**
     * Closing format for single tag.
     *
     * Formats:
     *
     * tag: `<br></br>`, slash: `<br />`, default: `<br>`
     *
     */
    closingSingleTag?: closingSingleTagOptionEnum;
    /**
     * If all attributes should be quoted.
     * Otherwise attributes will be unquoted when allowed.
     *
     * @default true
     */
    quoteAllAttributes?: boolean;
    /**
     * Replaces quotes in attribute values with `&quote;`.
     *
     * @default true
     */
    replaceQuote?: boolean;
    /**
     * Quote style
     *
     * 0 - Smart quotes
     *   <img src="https://example.com/example.png" onload='testFunc("test")'>
     * 1 - Single quotes
     *   <img src='https://example.com/example.png' onload='testFunc("test")'>
     * 2 - double quotes
     *   <img src="https://example.com/example.png" onload="testFunc("test")">
     *
     * @default 2
     */
    quoteStyle?: quoteStyleEnum;
};
declare function render(tree?: Node | Node[], options?: Options): string;

export { Node, Options, closingSingleTagOptionEnum, closingSingleTagTypeEnum, quoteStyleEnum, render };