Class Alias

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

clone resolve toJSON toString

Constructors

constructor

  • new Alias(source): Alias

  • Parameters

    • source: string

    Returns Alias

Properties

Readonly[NODE_TYPE]

[NODE_TYPE]: symbol

Optionalanchor

anchor?: undefined

Optionalcomment

comment?: null | string

A comment on or immediately after this

OptionalcommentBefore

commentBefore?: null | string

A comment before this

Optionalrange

range?: null | 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?: yaml.CST.Token

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

toJSON

  • toJSON(_arg?, ctx?): null | {}

  • A plain JS representation of this node

    Parameters

    • Optional_arg: unknown
    • Optionalctx: ToJSContext

    Returns null | {}

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

Constructors
Properties
Methods