Class YAMLOMap

Hierarchy (view full)

Constructors

constructor

Properties

[NODE_TYPE] add addToJSMap? anchor? comment? commentBefore? delete flow? get has items range? schema set spaceBefore? srcToken? tag? tag

Accessors

tagName

Methods

addIn clone deleteIn getIn hasAllNullValues hasIn setIn toJS toJSON toString from

Constructors

constructor

Properties

[NODE_TYPE]

[NODE_TYPE]: symbol

add

add: ((pair: Pair<any, any> | {
    key: any;
    value: any;
}, overwrite?: boolean) => void)

Type declaration

    • (pair, overwrite?): void

    • Adds a value to the collection.

      Parameters

      • pair: Pair<any, any> | {
            key: any;
            value: any;
        }
      • Optionaloverwrite: boolean

        If not set true, using a key that is already in the collection will throw. Otherwise, overwrites the previous value.

      Returns void

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?: string

An optional anchor on this node. Used by alias nodes.

Optionalcomment

comment?: null | string

A comment on or immediately after this

OptionalcommentBefore

commentBefore?: null | string

A comment before this

delete

delete: ((key: unknown) => boolean)

Removes a value from the collection.

key must contain a representation of an integer for this to succeed. It may be wrapped in a Scalar.

Type declaration

    • (key): boolean

    • Removes a value from the collection.

      Parameters

      • key: unknown

      Returns boolean

      true if the item was found and removed.

Returns

true if the item was found and removed.

Optionalflow

flow?: boolean

If true, stringify this and all child nodes using flow rather than block styles.

get

get: {
    (key: unknown, keepScalar: true): undefined | Scalar<any>;
    (key: unknown, keepScalar?: false): any;
    (key: unknown, keepScalar?: boolean): any;
}

Returns item at key, or undefined if not found. By default unwraps scalar values from their surrounding node; to disable set keepScalar to true (collections are always returned intact).

key must contain a representation of an integer for this to succeed. It may be wrapped in a Scalar.

Type declaration

    • (key, keepScalar): undefined | Scalar<any>

    • Returns item at key, or undefined if not found. By default unwraps scalar values from their surrounding node; to disable set keepScalar to true (collections are always returned intact).

      Parameters

      • key: unknown
      • keepScalar: true

      Returns undefined | Scalar<any>

    • (key, keepScalar?): any

    • Returns item at key, or undefined if not found. By default unwraps scalar values from their surrounding node; to disable set keepScalar to true (collections are always returned intact).

      Parameters

      • key: unknown
      • OptionalkeepScalar: false

      Returns any

    • (key, keepScalar?): any

    • Returns item at key, or undefined if not found. By default unwraps scalar values from their surrounding node; to disable set keepScalar to true (collections are always returned intact).

      Parameters

      • key: unknown
      • OptionalkeepScalar: boolean

      Returns any

has

has: ((key: unknown) => boolean)

Checks if the collection includes a value with the key key.

key must contain a representation of an integer for this to succeed. It may be wrapped in a Scalar.

Type declaration

    • (key): boolean

    • Checks if the collection includes a value with the key key.

      Parameters

      • key: unknown

      Returns boolean

items

items: unknown[]

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.

schema

schema: undefined | yaml.Schema

set

set: ((key: any, value: any) => void)

Sets a value in this collection. For !!set, value needs to be a boolean to add/remove the item from the set.

If key does not contain a representation of an integer, this will throw. It may be wrapped in a Scalar.

Type declaration

    • (key, value): void

    • Sets a value in this collection. For !!set, value needs to be a boolean to add/remove the item from the set.

      Parameters

      • key: any
      • value: any

      Returns void

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

Statictag

tag: string

Accessors

StatictagName

  • get tagName(): "tag:yaml.org,2002:seq"

  • Returns "tag:yaml.org,2002:seq"

Methods

addIn

  • addIn(path, value): void

  • Adds a value to the collection. For !!map and !!omap the value must be a Pair instance or a { key, value } object, which may not have a key that already exists in the map.

    Parameters

    • path: Iterable<unknown>
    • value: unknown

    Returns void

clone

  • clone(schema?): Collection

  • Create a copy of this collection.

    Parameters

    • Optionalschema: yaml.Schema

      If defined, overwrites the original's schema

    Returns Collection

deleteIn

  • deleteIn(path): boolean

  • Removes a value from the collection.

    Parameters

    • path: Iterable<unknown>

    Returns boolean

    true if the item was found and removed.

getIn

  • getIn(path, keepScalar?): unknown

  • Returns item at key, or undefined if not found. By default unwraps scalar values from their surrounding node; to disable set keepScalar to true (collections are always returned intact).

    Parameters

    • path: Iterable<unknown>
    • OptionalkeepScalar: boolean

    Returns unknown

hasAllNullValues

  • hasAllNullValues(allowScalar?): boolean

  • Parameters

    • OptionalallowScalar: boolean

    Returns boolean

hasIn

  • hasIn(path): boolean

  • Checks if the collection includes a value with the key key.

    Parameters

    • path: Iterable<unknown>

    Returns boolean

setIn

  • setIn(path, value): void

  • Sets a value in this collection. For !!set, value needs to be a boolean to add/remove the item from the set.

    Parameters

    • path: Iterable<unknown>
    • value: unknown

    Returns void

toJS

  • toJS(doc, __namedParameters?): any

  • A plain JavaScript representation of this node.

    Parameters

    Returns any

toJSON

  • toJSON(_?, ctx?): unknown[]

  • If ctx is given, the return type is actually Map<unknown, unknown>, but TypeScript won't allow widening the signature of a child method.

    Parameters

    • Optional_: unknown
    • Optionalctx: ToJSContext

    Returns unknown[]

toString

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

  • Parameters

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

        • Returns void

    • OptionalonChompKeep: (() => void)
        • (): void

        • Returns void

    Returns string

Staticfrom

  • from(schema, iterable, ctx): YAMLOMap

  • Parameters

    • schema: yaml.Schema
    • iterable: unknown
    • ctx: CreateNodeContext

    Returns YAMLOMap

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods