UNPKG

1.52 kBTypeScriptView Raw
1import YAMLException = require('./exception');
2export declare enum Kind {
3 SCALAR = 0,
4 MAPPING = 1,
5 MAP = 2,
6 SEQ = 3,
7 ANCHOR_REF = 4,
8 INCLUDE_REF = 5,
9}
10export interface YAMLDocument {
11 startPosition: number;
12 endPosition: number;
13 errors: YAMLException[];
14}
15export interface YAMLNode extends YAMLDocument {
16 startPosition: number;
17 endPosition: number;
18 kind: Kind;
19 anchorId?: string;
20 valueObject?: any;
21 parent: YAMLNode;
22 errors: YAMLException[];
23 value?: any;
24 key?: any;
25 mappings?: any;
26}
27export interface YAMLAnchorReference extends YAMLNode {
28 referencesAnchor: string;
29 value: YAMLNode;
30}
31export interface YAMLScalar extends YAMLNode {
32 value: string;
33 doubleQuoted?: boolean;
34 singleQuoted?: boolean;
35 plainScalar?: boolean;
36 rawValue: string;
37}
38export interface YAMLMapping extends YAMLNode {
39 key: YAMLScalar;
40 value: YAMLNode;
41}
42export interface YAMLSequence extends YAMLNode {
43 items: YAMLNode[];
44}
45export interface YamlMap extends YAMLNode {
46 mappings: YAMLMapping[];
47}
48export declare function newMapping(key: YAMLScalar, value: YAMLNode): YAMLMapping;
49export declare function newAnchorRef(key: string, start: number, end: number, value: YAMLNode): YAMLAnchorReference;
50export declare function newScalar(v?: string | boolean | number): YAMLScalar;
51export declare function newItems(): YAMLSequence;
52export declare function newSeq(): YAMLSequence;
53export declare function newMap(mappings?: YAMLMapping[]): YamlMap;