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

    Interface ReadOmlOptions

    Options for parsing OML source text into a Document node (spec §4).

    interface ReadOmlOptions {
        maxDepth?: number;
        maxInputBytes?: number;
        maxIntDigits?: number;
        maxNodes?: number;
        schema?: Schema;
    }
    Index
    maxDepth?: number

    Nesting-depth limit (spec D-9): see DocumentLimits.maxDepth. Default 200.

    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 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

    Integer-digit limit (spec D-9, D-28): see DocumentLimits.maxIntDigits. Default 4300.

    maxNodes?: number

    Node-count limit (spec D-9): see DocumentLimits.maxNodes. Default 1 000 000.

    schema?: Schema

    If given, the parsed document is run through materialize (issue #7, src/deserialize.ts) against this schema: leaf values are upgraded (e.g. an ISO date string to a Date) and the shape is checked (cardinality, closedness), guaranteeing the result conforms -- or raising ParseError with the full structured issue list otherwise.