StringifyOptions - @std/yaml

type alias StringifyOptions

Options for stringify.

Properties

optional

indent: number = 2

Indentation width to use (in spaces).

optional

arrayIndent: boolean = true

When true, adds an indentation level to array elements.

optional

skipInvalid: boolean = false

Do not throw on invalid types (like function in the safe schema) and skip pairs and single values with such types.

optional

flowLevel: number = -1

Specifies level of nesting, when to switch from block to flow style for collections. -1 means block style everywhere.

optional

styles: Record<string, StyleVariant>

Each tag may have own set of styles. - "tag" => "style" map.

optional

schema: SchemaType = "default"

Name of the schema to use.

optional

sortKeys: boolean | ((a: string,
b: string,
depth: number
) => number) = false

If true, sort keys when dumping YAML in ascending, ASCII character order. If a function, use the function to sort the keys. 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.

optional

lineWidth: number = 80

Set max line width.

optional

useAnchors: boolean = true

If false, don't convert duplicate objects into references.

optional

compatMode: boolean = true

If false 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.

optional

condenseFlow: boolean = false

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.