deno.land / std@0.224.0 / yaml / _dumper / dumper_state.ts

dumper_state.ts
View Documentation
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
// Ported from js-yaml v3.13.1:// https://github.com/nodeca/js-yaml/commit/665aadda42349dcae869f12040d9b10ef18d12da// Copyright 2011-2015 by Vitaly Puzrin. All rights reserved. MIT license.// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
import type { Schema, SchemaDefinition } from "../schema.ts";import { State } from "../_state.ts";import type { StyleVariant, Type } from "../type.ts";import type { Any, ArrayObject } from "../_utils.ts";
const { hasOwn } = Object;
function compileStyleMap( schema: Schema, map?: ArrayObject<StyleVariant> | null,): ArrayObject<StyleVariant> { if (typeof map === "undefined" || map === null) return {};
const result: ArrayObject<StyleVariant> = {}; for (let tag of Object.keys(map)) { let style = String(map[tag]) as StyleVariant; if (tag.slice(0, 2) === "!!") { tag = `tag:yaml.org,2002:${tag.slice(2)}`; } const type = schema.compiledTypeMap.fallback[tag];
if ( type && typeof type.styleAliases !== "undefined" && hasOwn(type.styleAliases, style) ) { style = type.styleAliases[style]; }
result[tag] = style; }
return result;}
export interface DumperStateOptions { /** indentation width to use (in spaces). */ indent?: number; /** when true, will not add an indentation level to array elements */ noArrayIndent?: boolean; /** * do not throw on invalid types (like function in the safe schema) * and skip pairs and single values with such types. */ skipInvalid?: boolean; /** * specifies level of nesting, when to switch from * block to flow style for collections. -1 means block style everywhere */ flowLevel?: number; /** Each tag may have own set of styles. - "tag" => "style" map. */ styles?: ArrayObject<StyleVariant> | null; /** specifies a schema to use. */ schema?: SchemaDefinition; /** * If true, sort keys when dumping YAML in ascending, ASCII character order. * If a function, use the function to sort the keys. (default: false) * If a function is specified, the function must return a negative value * if first argument is less than second argument, zero if they're equal * and a positive value otherwise. */ sortKeys?: boolean | ((a: string, b: string) => number); /** set max line width. (default: 80) */ lineWidth?: number; /** * if true, don't convert duplicate objects * into references (default: false) */ noRefs?: boolean; /** * if true don't try to be compatible with older yaml versions. * Currently: don't quote "yes", "no" and so on, * as required for YAML 1.1 (default: false) */ noCompatMode?: boolean; /** * if true flow sequences will be condensed, omitting the * space between `key: value` or `a, b`. Eg. `'[a,b]'` or `{a:{b:c}}`. * Can be useful when using yaml for pretty URL query params * as spaces are %-encoded. (default: false). */ condenseFlow?: boolean;}
export class DumperState extends State { public indent: number; public noArrayIndent: boolean; public skipInvalid: boolean; public flowLevel: number; public sortKeys: boolean | ((a: Any, b: Any) => number); public lineWidth: number; public noRefs: boolean; public noCompatMode: boolean; public condenseFlow: boolean; public implicitTypes: Type[]; public explicitTypes: Type[]; public tag: string | null = null; public result = ""; public duplicates: Any[] = []; public usedDuplicates: Any[] = []; // changed from null to [] public styleMap: ArrayObject<StyleVariant>; public dump: Any;
constructor({ schema, indent = 2, noArrayIndent = false, skipInvalid = false, flowLevel = -1, styles = null, sortKeys = false, lineWidth = 80, noRefs = false, noCompatMode = false, condenseFlow = false, }: DumperStateOptions) { super(schema); this.indent = Math.max(1, indent); this.noArrayIndent = noArrayIndent; this.skipInvalid = skipInvalid; this.flowLevel = flowLevel; this.styleMap = compileStyleMap(this.schema as Schema, styles); this.sortKeys = sortKeys; this.lineWidth = lineWidth; this.noRefs = noRefs; this.noCompatMode = noCompatMode; this.condenseFlow = condenseFlow;
this.implicitTypes = (this.schema as Schema).compiledImplicit; this.explicitTypes = (this.schema as Schema).compiledExplicit; }}
std

Version Info

Tagged at
6 months ago