ts-lambda-api - v2.5.2
    Preparing search index...

    Interface CollectionTag

    interface CollectionTag {
        collection: "map" | "seq";
        createNode?: (
            schema: Schema,
            value: unknown,
            ctx: CreateNodeContext,
        ) => Node;
        default?: boolean | "key";
        format?: string;
        identify?: (value: unknown) => boolean;
        nodeClass?: {
            from?: (schema: Schema, obj: unknown, ctx: CreateNodeContext) => Node;
            new (schema?: Schema): Node;
        };
        resolve?: (
            value: Parsed<ParsedNode, ParsedNode> | Parsed<ParsedNode>,
            onError: (message: string) => void,
            options: ParseOptions,
        ) => unknown;
        stringify?: never;
        tag: string;
        test?: never;
    }

    Hierarchy (View Summary)

    Index

    Properties

    collection createNode? default? format? identify? nodeClass? resolve? stringify? tag test?

    Properties

    collection: "map" | "seq"

    The source collection type supported by this tag.

    createNode?: (schema: Schema, value: unknown, ctx: CreateNodeContext) => Node

    An optional factory function, used e.g. by collections when wrapping JS objects as AST nodes.

    default?: boolean | "key"

    If true, allows for values to be stringified without an explicit tag together with test. If 'key', this only applies if the value is used as a mapping key. For most cases, it's unlikely that you'll actually want to use this, even if you first think you do.

    format?: string

    If a tag has multiple forms that should be parsed and/or stringified differently, use format to identify them.

    identify?: (value: unknown) => boolean

    Used by YAML.createNode to detect your data type, e.g. using typeof or instanceof.

    nodeClass?: {
        from?: (schema: Schema, obj: unknown, ctx: CreateNodeContext) => Node;
        new (schema?: Schema): Node;
    }

    The Node child class that implements this tag. If set, used to select this tag when stringifying.

    If the class provides a static from method, then that will be used if the tag object doesn't have a createNode method.

    resolve?: (
        value: Parsed<ParsedNode, ParsedNode> | Parsed<ParsedNode>,
        onError: (message: string) => void,
        options: ParseOptions,
    ) => unknown

    Turns a value into an AST node. If returning a non-Node value, the output will be wrapped as a Scalar.

    Note: this is required if nodeClass is not provided.

    stringify?: never
    tag: string

    The identifier for your data type, with which its stringified form will be prefixed. Should either be a !-prefixed local !tag, or a fully qualified tag:domain,date:foo.

    test?: never

    Settings

    Member Visibility

    On This Page

    Properties