js-yaml - v5.3.0
    Preparing search index...

    Interface DumpOptions

    interface DumpOptions {
        indent?: number;
        seqNoIndent?: boolean;
        seqInlineFirst?: boolean;
        sortKeys?: boolean | ((a: any, b: any) => number);
        lineWidth?: number;
        flowBracketPadding?: boolean;
        flowSkipCommaSpace?: boolean;
        flowSkipColonSpace?: boolean;
        quoteFlowKeys?: boolean;
        quoteStyle?: "single" | "double";
        forceQuotes?: boolean;
        tagBeforeAnchor?: boolean;
        schema?: Schema;
        skipInvalid?: boolean;
        noRefs?: boolean;
        flowLevel?: number;
        transform?: (documents: Document[]) => void;
    }

    Hierarchy

    Index
    indent? seqNoIndent? seqInlineFirst? sortKeys? lineWidth? flowBracketPadding? flowSkipCommaSpace? flowSkipColonSpace? quoteFlowKeys? quoteStyle? forceQuotes? tagBeforeAnchor? schema? skipInvalid? noRefs? flowLevel? transform?
    indent?: number

    Indentation width in spaces.

    2

    seqNoIndent?: boolean

    Does not add an indentation level to array elements when enabled.

    false

    seqInlineFirst?: boolean

    Allows a nested collection to start on the same line after -.

    true

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

    Sorts mapping keys when true. A function can be provided to define the sort order.

    false

    lineWidth?: number

    Maximum line width. Set to -1 for unlimited width.

    80

    flowBracketPadding?: boolean

    Adds spaces inside flow collection brackets: {a: 1} becomes { a: 1 }.

    false

    flowSkipCommaSpace?: boolean

    Omits the space after commas in flow collections: [1, 2] becomes [1,2].

    false

    flowSkipColonSpace?: boolean

    Omits the space after : in flow mappings: {a: 1} becomes {a:1}.

    false

    quoteFlowKeys?: boolean

    Quotes flow mapping keys: {a: 1} becomes {"a": 1}.

    false

    quoteStyle?: "single" | "double"

    Quoting style to use when a string needs quotes.

    'single'

    forceQuotes?: boolean

    Quotes all non-key strings using quoteStyle.

    false

    tagBeforeAnchor?: boolean

    Prints an explicit tag before an anchor: &ref_0 !!set becomes !!set &ref_0.

    false

    schema?: Schema

    Schema to use.

    DUMP_SCHEMA

    skipInvalid?: boolean

    Skips invalid types instead of throwing. Invalid mapping pairs and sequence items are skipped; undefined sequence items are serialized as null.

    false

    noRefs?: boolean

    Inlines duplicate objects instead of converting them into references.

    false

    flowLevel?: number

    Nesting level at which collections switch from block to flow style. Set to -1 to never switch automatically.

    -1

    transform?: (documents: Document[]) => void

    Mutates the generated AST before it is rendered.

    Settings
    Member Visibility

    On This Page
    Properties