Options
All
  • Public
  • Public/Protected
  • All
Menu

Class YAMLMap<K, V>

Type parameters

  • K = unknown

  • V = unknown

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Type parameters

    • K = unknown

    • V = unknown

    Parameters

    Returns YAMLMap<K, V>

Properties

[NODE_TYPE]

[NODE_TYPE]: symbol

Optional anchor

anchor?: string

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

Optional comment

comment?: null | string

A comment on or immediately after this

Optional commentBefore

commentBefore?: null | string

A comment before this

Optional flow

flow?: boolean

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

items

items: Pair<K, V>[]

Optional range

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

Optional spaceBefore

spaceBefore?: boolean

A blank line before this node and its commentBefore

Optional srcToken

srcToken?: Token

The CST token that was composed into this node.

Optional tag

tag?: string

A fully qualified tag, if required

Static maxFlowStringSingleLineLength

maxFlowStringSingleLineLength: number

Accessors

Static tagName

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

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

Methods

add

  • add(pair: Pair<K, V> | { key: K; value: V }, overwrite?: boolean): void

  • Adds a value to the collection.

    Parameters

    • pair: Pair<K, V> | { key: K; value: V }
    • Optional overwrite: boolean

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

    Returns void

addIn

  • addIn(path: Iterable<unknown>, value: unknown): 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

  • Create a copy of this collection.

    Parameters

    • Optional schema: yaml.Schema

      If defined, overwrites the original's schema

    Returns Collection

delete

  • delete(key: unknown): boolean

  • Parameters

    • key: unknown

    Returns boolean

deleteIn

  • deleteIn(path: Iterable<unknown>): boolean

  • Removes a value from the collection.

    Parameters

    • path: Iterable<unknown>

    Returns boolean

    true if the item was found and removed.

get

  • get(key: unknown, keepScalar: true): undefined | Scalar<V>
  • get(key: unknown, keepScalar?: false): undefined | V
  • get(key: unknown, keepScalar?: boolean): undefined | V | Scalar<V>

  • Parameters

    • key: unknown
    • keepScalar: true

    Returns undefined | Scalar<V>

  • Parameters

    • key: unknown
    • Optional keepScalar: false

    Returns undefined | V

  • Parameters

    • key: unknown
    • Optional keepScalar: boolean

    Returns undefined | V | Scalar<V>

getIn

  • getIn(path: Iterable<unknown>, keepScalar?: boolean): 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>
    • Optional keepScalar: boolean

    Returns unknown

has

  • has(key: unknown): boolean

  • Parameters

    • key: unknown

    Returns boolean

hasAllNullValues

  • hasAllNullValues(allowScalar?: boolean): boolean

  • Parameters

    • Optional allowScalar: boolean

    Returns boolean

hasIn

  • hasIn(path: Iterable<unknown>): boolean

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

    Parameters

    • path: Iterable<unknown>

    Returns boolean

set

  • set(key: K, value: V): void

  • Parameters

    • key: K
    • value: V

    Returns void

setIn

  • setIn(path: Iterable<unknown>, value: unknown): 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

toJSON

  • toJSON<T>(_?: unknown, ctx?: ToJSContext, Type?: new () => T): any

  • Type parameters

    • T: MapLike = Map<unknown, unknown>

    Parameters

    • Optional _: unknown
    • Optional ctx: ToJSContext

      Conversion context, originally set in Document#toJS()

    • Optional Type: new () => T

      If set, forces the returned collection type

        • new (): T

        • Returns T

    Returns any

    Instance of Type, Map, or Object

toString

  • toString(ctx?: StringifyContext, onComment?: () => void, onChompKeep?: () => void): string

  • Parameters

    • Optional ctx: StringifyContext
    • Optional onComment: () => void
        • (): void

        • Returns void

    • Optional onChompKeep: () => void
        • (): void

        • Returns void

    Returns string

Generated using TypeDoc