@omnist-dev/omnist
    Preparing search index...

    Interface ReadYamlOptions

    Options for parsing YAML text into a Document node.

    interface ReadYamlOptions {
        maxAliasExpansion?: number;
        maxDepth?: number;
        maxExpandedSlots?: number;
        maxInputBytes?: number;
        maxIntDigits?: number;
        maxNodes?: number;
        schema?: Schema;
    }

    Hierarchy (View Summary)

    Index
    maxAliasExpansion?: number

    The maximum alias expansion factor (spec D-18, §2.4.1): the ratio of the value slots an anchored node, mapping, or sequence materializes to the slots it is written with. Input over it is rejected with document.limit.alias-expansion, before any alias is expanded. Default 50; an integer from 1 to 10000. Zero or negative selects the default (never "no limit"); a larger or non-integer value throws a RangeError.

    maxDepth?: number

    The deepest nesting accepted, counted in levels of node nesting from the Document root (the root is level 1): at 3, a: { b: { c: 1 } } is read and a: { b: { c: { d: 1 } } } is refused with document.limit.depth at $. Default 200. Raising it far is bounded by the JavaScript call stack.

    maxExpandedSlots?: number

    The maximum expanded size (spec D-22, §2.4.1): the value slots one input materializes. An input that contains at least one alias or merge key is rejected with document.limit.expanded-size when it materializes more, after the expansion-factor check and before any alias is expanded; an input with neither is exempt however large. Default 1 000 000; an integer from 1 to 10 000 000. Zero or negative selects the default (never "no limit"); a larger or non-integer value throws a RangeError.

    maxInputBytes?: number

    The largest input, in UTF-8 bytes, that is read at all (spec D-23, Sec2.4.2): a larger input is refused with document.limit.input-size at $ before it is decoded or parsed; one of exactly this size is accepted. A leading byte-order mark counts. Default 64 MiB; an integer of at least 1, else a RangeError.

    maxIntDigits?: number

    The most decimal digits an integer's value may have, sign excluded; a hex, octal, binary or underscored literal is counted by the value it denotes (D-28). More is refused with document.limit.int-digits at the literal's Document path. Default 4300.

    maxNodes?: number

    The most nodes one Document may hold, the root included and scalar leaves not. More is refused with document.limit.nodes at $. Default 1 000 000.

    schema?: Schema

    Optional Schema for schema-directed materialization (spec §4).