Type Alias StringifyOptions

StringifyOptions: {
    arrayIndent?: boolean;
    compatMode?: boolean;
    condenseFlow?: boolean;
    flowLevel?: number;
    indent?: number;
    lineWidth?: number;
    schema?: SchemaType;
    skipInvalid?: boolean;
    sortKeys?: boolean | ((a: string, b: string) => number);
    styles?: Record<string, StyleVariant>;
    useAnchors?: boolean;
}

Options for stringify.

Type declaration

  • OptionalarrayIndent?: boolean

    When true, adds an indentation level to array elements.

    Default

    {true}
  • OptionalcompatMode?: boolean

    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.

    Default

    {true}
  • OptionalcondenseFlow?: 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}
  • OptionalflowLevel?: number

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

    Default

    {-1}
  • Optionalindent?: number

    Indentation width to use (in spaces).

    Default

    {2}
  • OptionallineWidth?: number

    Set max line width.

    Default

    {80}
  • Optionalschema?: SchemaType

    Name of the schema to use.

    Default

    {"default"}
  • OptionalskipInvalid?: boolean

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

    Default

    {false}
  • OptionalsortKeys?: 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. 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.

    Default

    {false}
  • Optionalstyles?: Record<string, StyleVariant>

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

  • OptionaluseAnchors?: boolean

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

    Default

    {true}

Settings

Member Visibility