Interface ScalarTag

interface ScalarTag {
    collection?: undefined;
    createNode?: ((schema: yaml.Schema, value: unknown, ctx: CreateNodeContext) => yaml.Node);
    default?: boolean | "key";
    format?: string;
    identify?: ((value: unknown) => boolean);
    nodeClass?: undefined;
    stringify?: ((item: Scalar<unknown>, ctx: StringifyContext, onComment?: (() => void), onChompKeep?: (() => void)) => string);
    tag: string;
    test?: RegExp;
    resolve(value: string, onError: ((message: string) => void), options: ParseOptions): unknown;
}

Hierarchy

  • TagBase
    • ScalarTag

Properties

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

Methods

resolve

Properties

Optionalcollection

collection?: undefined

OptionalcreateNode

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

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

Optionaldefault

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.

Optionalformat

format?: string

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

Optionalidentify

identify?: ((value: unknown) => boolean)

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

OptionalnodeClass

nodeClass?: undefined

Optionalstringify

stringify?: ((item: Scalar<unknown>, ctx: StringifyContext, onComment?: (() => void), onChompKeep?: (() => void)) => string)

Optional function stringifying a Scalar node. If your data includes a suitable .toString() method, you can probably leave this undefined and use the default stringifier.

Type declaration

    • (item, ctx, onComment?, onChompKeep?): string

    • Parameters

      • item: Scalar<unknown>

        The node being stringified.

      • ctx: StringifyContext

        Contains the stringifying context variables.

      • OptionalonComment: (() => void)

        Callback to signal that the stringifier includes the item's comment in its output.

          • (): void

          • Returns void

      • OptionalonChompKeep: (() => void)

        Callback to signal that the output uses a block scalar type with the + chomping indicator.

          • (): void

          • Returns void

      Returns string

tag

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.

Optionaltest

test?: RegExp

Together with default allows for values to be stringified without an explicit tag and detected using a regular expression. For most cases, it's unlikely that you'll actually want to use these, even if you first think you do.

Methods

resolve

  • resolve(value, onError, options): unknown

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

    Parameters

    • value: string
    • onError: ((message: string) => void)
        • (message): void

        • Parameters

          • message: string

          Returns void

    • options: ParseOptions

    Returns unknown

Settings

Member Visibility

On This Page

Properties
Methods