DumperStateOptions | /encoding/yaml/dumper/dumper_state.ts | std@0.36.0

interface DumperStateOptions

import { type DumperStateOptions } from "https://deno.land/std@0.36.0/encoding/yaml/dumper/dumper_state.ts";

Properties

optional

indent: number

indentation width to use (in spaces).

optional

noArrayIndent: boolean

when true, will not add an indentation level to array elements

optional

skipInvalid: boolean

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

optional

flowLevel: number

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

optional

styles: ArrayObject<StyleVariant> | null

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

optional

schema: SchemaDefinition

specifies a schema to use.

optional

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

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.

optional

lineWidth: number

set max line width. (default: 80)

optional

noRefs: boolean

if true, don't convert duplicate objects into references (default: false)

optional

noCompatMode: 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)

optional

condenseFlow: 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).