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

    Interface MappingTagDefinition<Carrier, Result>

    Normalized mapping tag returned by defineMappingTag.

    interface MappingTagDefinition<Carrier = unknown, Result = Carrier> {
        matchByTagPrefix: boolean;
        create: (tagName: string) => Carrier;
        addPair: (carrier: Carrier, key: unknown, value: unknown) => string;
        has: (carrier: Carrier, key: unknown) => boolean;
        keys: (result: Result) => Iterable<unknown>;
        get: (result: Result, key: unknown) => unknown;
        finalize: (carrier: Carrier) => Result;
        identify: (data: any) => boolean;
        represent: (data: any) => Map<unknown, unknown>;
        representTagName: (data: any) => string;
        tagName: string;
        nodeKind: "mapping";
        implicit: false;
        carrierIsResult: boolean;
    }

    Type Parameters

    • Carrier = unknown
    • Result = Carrier

    Hierarchy

    Index
    matchByTagPrefix create addPair has keys get finalize identify represent representTagName tagName nodeKind implicit carrierIsResult
    matchByTagPrefix: boolean

    Whether explicit tag names are matched by prefix instead of exact equality. Default: false.

    create: (tagName: string) => Carrier

    Create the carrier used while constructing a mapping.

    addPair: (carrier: Carrier, key: unknown, value: unknown) => string

    Writes a pair. Returns '' on success, a non-empty error message otherwise (key does not fit the representation, value rejected, ...). Always a string so the hot path never allocates an exception wrapper.

    has: (carrier: Carrier, key: unknown) => boolean

    Return whether the carrier contains a key, for duplicate and merge checks.

    keys: (result: Result) => Iterable<unknown>

    Return the keys of a completed result for YAML merge processing.

    get: (result: Result, key: unknown) => unknown

    Return a value from a completed result for YAML merge processing.

    finalize: (carrier: Carrier) => Result

    Convert the completed carrier to the result. Defaults to the identity function.

    identify: (data: any) => boolean

    Selects this tag for a JavaScript value when dumping. Use () => false for load-only tags.

    represent: (data: any) => Map<unknown, unknown>

    Return the mapping entries to dump. Defaults to the identity function.

    representTagName: (data: any) => string

    Return the tag name to emit for a prefix-matching tag. Defaults to tagName.

    tagName: string

    Tag name used for schema lookup.

    nodeKind: "mapping"

    YAML node kind handled by this tag.

    implicit: false

    Mapping tags do not participate in implicit scalar resolution.

    carrierIsResult: boolean

    Whether the carrier is also the final result (finalize was omitted).

    Settings
    Member Visibility

    On This Page
    Properties