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

    Interface PresenterOptions

    interface PresenterOptions {
        schema: Schema;
        indent?: number;
        seqNoIndent?: boolean;
        seqInlineFirst?: boolean;
        lineWidth?: number;
        flowBracketPadding?: boolean;
        flowSkipCommaSpace?: boolean;
        flowSkipColonSpace?: boolean;
        quoteFlowKeys?: boolean;
        quoteStyle?: "single" | "double";
        forceQuotes?: boolean;
        scalarStyleRules?: readonly ScalarStyleRule[];
        tagBeforeAnchor?: boolean;
    }
    Index
    schema indent? seqNoIndent? seqInlineFirst? lineWidth? flowBracketPadding? flowSkipCommaSpace? flowSkipColonSpace? quoteFlowKeys? quoteStyle? forceQuotes? scalarStyleRules? tagBeforeAnchor?
    schema: Schema

    Schema used when selecting a safe scalar style.

    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

    lineWidth?: number

    Preferred line width for folding. Unbreakable and more-indented lines may exceed it. 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}.

    This forces quoteFlowKeys; otherwise a:1 would be parsed as a single plain scalar instead of a mapping entry.

    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

    scalarStyleRules?: readonly ScalarStyleRule[]

    Customizes how strings are rendered as plain, quoted, literal, or folded scalars. Rules are applied in array order; providing this option replaces the default rules.

    Object.values(DEFAULT_SCALAR_STYLE_RULES)

    tagBeforeAnchor?: boolean

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

    false

    Settings
    Member Visibility

    On This Page
    Properties