Interface Parsed

interface Parsed {
    [NODE_TYPE]: symbol;
    addToJSMap?: ((ctx: undefined | ToJSContext, map: MapLike, value: unknown) => void);
    anchor?: undefined;
    comment?: null | string;
    commentBefore?: null | string;
    range: Range;
    source: string;
    spaceBefore?: boolean;
    srcToken?: FlowScalar & {
        type: "alias";
    };
    tag?: string;
    clone(): NodeBase;
    resolve(doc: yaml.Document<yaml.Node, true>, ctx?: ToJSContext):
        | undefined
        | Scalar<unknown>
        | YAMLMap<unknown, unknown>
        | YAMLSeq<unknown>;
    toJS(doc: yaml.Document<yaml.Node<unknown>, boolean>, __namedParameters?: ToJSOptions): any;
    toJSON(_arg?: unknown, ctx?: ToJSContext): unknown;
    toString(ctx?: StringifyContext, _onComment?: (() => void), _onChompKeep?: (() => void)): string;
}

Hierarchy (view full)

Properties

[NODE_TYPE] addToJSMap? anchor? comment? commentBefore? range source spaceBefore? srcToken? tag?

Methods

clone resolve toJS toJSON toString

Properties

Readonly[NODE_TYPE]

[NODE_TYPE]: symbol

OptionaladdToJSMap

addToJSMap?: ((ctx: undefined | ToJSContext, map: MapLike, value: unknown) => void)

Customize the way that a key-value pair is resolved. Used for YAML 1.1 !!merge << handling.

Optionalanchor

anchor?: undefined

Optionalcomment

comment?: null | string

A comment on or immediately after this

OptionalcommentBefore

commentBefore?: null | string

A comment before this

range

range: Range

The [start, value-end, node-end] character offsets for the part of the source parsed into this node (undefined if not parsed). The value-end and node-end positions are themselves not included in their respective ranges.

source

source: string

OptionalspaceBefore

spaceBefore?: boolean

A blank line before this node and its commentBefore

OptionalsrcToken

srcToken?: FlowScalar & {
    type: "alias";
}

The CST token that was composed into this node.

Optionaltag

tag?: string

A fully qualified tag, if required

Methods

clone

  • clone(): NodeBase

  • Create a copy of this node.

    Returns NodeBase

resolve

  • resolve(doc, ctx?):
        | undefined
        | Scalar<unknown>
        | YAMLMap<unknown, unknown>
        | YAMLSeq<unknown>

  • Resolve the value of this alias within doc, finding the last instance of the source anchor before this node.

    Parameters

    Returns
        | undefined
        | Scalar<unknown>
        | YAMLMap<unknown, unknown>
        | YAMLSeq<unknown>

toJS

  • toJS(doc, __namedParameters?): any

  • A plain JavaScript representation of this node.

    Parameters

    Returns any

toJSON

  • toJSON(_arg?, ctx?): unknown

  • A plain JS representation of this node

    Parameters

    • Optional_arg: unknown
    • Optionalctx: ToJSContext

    Returns unknown

toString

  • toString(ctx?, _onComment?, _onChompKeep?): string

  • Parameters

    • Optionalctx: StringifyContext
    • Optional_onComment: (() => void)
        • (): void

        • Returns void

    • Optional_onChompKeep: (() => void)
        • (): void

        • Returns void

    Returns string

Settings

Member Visibility

On This Page

Properties
Methods