Class YAMLMap<K, V>

Type Parameters

K = unknown
V = unknown

Hierarchy (View Summary)

Collection
- YAMLMap
  - Parsed

Index

Constructors

constructor

new YAMLMap<K = unknown, V = unknown>(schema?: Schema): YAMLMap<K, V>
Type Parameters
- K = unknown
- V = unknown
Parameters
- Optionalschema: Schema
Returns YAMLMap<K, V>
Overrides Collection.constructor
- Defined in node_modules/yaml/dist/nodes/YAMLMap.d.ts:22

Properties

[NODE_TYPE]

"[NODE_TYPE]": symbol

`Optional`addToJSMap

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

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

`Optional`anchor

anchor?: string

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

`Optional`comment

comment?: string

A comment on or immediately after this

`Optional`commentBefore

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

Accessors

`Static`tagName

get tagName(): "tag:yaml.org,2002:map"
Returns "tag:yaml.org,2002:map"
- Defined in node_modules/yaml/dist/nodes/YAMLMap.d.ts:20

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 }
- Optionaloverwrite: boolean
  If not set true, using a key that is already in the collection will throw. Otherwise, overwrites the previous value.
Returns void
Overrides Collection.add
- Defined in node_modules/yaml/dist/nodes/YAMLMap.d.ts:34

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
Inherited from Collection.addIn
- Defined in node_modules/yaml/dist/nodes/Collection.d.ts:51

clone

clone(schema?: Schema): Collection
Create a copy of this collection.
Parameters
- Optionalschema: Schema
  If defined, overwrites the original's schema
Returns Collection
Inherited from Collection.clone
- Defined in node_modules/yaml/dist/nodes/Collection.d.ts:23

delete

delete(key: unknown): boolean
Removes a value from the collection.
Parameters
- key: unknown
Returns boolean
true if the item was found and removed.
Overrides Collection.delete
- Defined in node_modules/yaml/dist/nodes/YAMLMap.d.ts:38

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.
Inherited from Collection.deleteIn
- Defined in node_modules/yaml/dist/nodes/Collection.d.ts:56

get

get(key: unknown, keepScalar: true): Scalar<V>
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 Scalar<V>
Overrides Collection.get
- Defined in node_modules/yaml/dist/nodes/YAMLMap.d.ts:39
get(key: unknown, keepScalar?: false): V
Parameters
- key: unknown
- OptionalkeepScalar: false
Returns V
Overrides Collection.get
- Defined in node_modules/yaml/dist/nodes/YAMLMap.d.ts:40
get(key: unknown, keepScalar?: boolean): V | Scalar<V>
Parameters
- key: unknown
- OptionalkeepScalar: boolean
Returns V | Scalar<V>
Overrides Collection.get
- Defined in node_modules/yaml/dist/nodes/YAMLMap.d.ts:41

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>
- OptionalkeepScalar: boolean
Returns unknown
Inherited from Collection.getIn
- Defined in node_modules/yaml/dist/nodes/Collection.d.ts:62

has

has(key: unknown): boolean
Checks if the collection includes a value with the key key.
Parameters
- key: unknown
Returns boolean
Overrides Collection.has
- Defined in node_modules/yaml/dist/nodes/YAMLMap.d.ts:42

hasAllNullValues

hasAllNullValues(allowScalar?: boolean): boolean
Parameters
- OptionalallowScalar: boolean
Returns boolean
Inherited from Collection.hasAllNullValues
- Defined in node_modules/yaml/dist/nodes/Collection.d.ts:63

hasIn

hasIn(path: Iterable<unknown>): boolean
Checks if the collection includes a value with the key key.
Parameters
- path: Iterable<unknown>
Returns boolean
Inherited from Collection.hasIn
- Defined in node_modules/yaml/dist/nodes/Collection.d.ts:67

set

set(key: K, value: V): 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: K
- value: V
Returns void
Overrides Collection.set
- Defined in node_modules/yaml/dist/nodes/YAMLMap.d.ts:43

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
Inherited from Collection.setIn
- Defined in node_modules/yaml/dist/nodes/Collection.d.ts:72

toJS

toJS(
doc: Document<Node<unknown>, boolean>,
__namedParameters?: ToJSOptions,
): any
A plain JavaScript representation of this node.
Parameters
- doc: Document<Node<unknown>, boolean>
- Optional__namedParameters: ToJSOptions
Returns any
Inherited from Collection.toJS
- Defined in node_modules/yaml/dist/nodes/Node.d.ts:52

toJSON

toJSON<T extends MapLike = Map<unknown, unknown>>(
    _?: unknown,
    ctx?: ToJSContext,
    Type?: new () => T,
): any
Type Parameters
- T extends MapLike = Map<unknown, unknown>
Parameters
- Optional_: unknown
- Optionalctx: ToJSContext
  Conversion context, originally set in Document#toJS()
- OptionalType: new () => T
  If set, forces the returned collection type
Returns any
Instance of Type, Map, or Object
Overrides Collection.toJSON
- Defined in node_modules/yaml/dist/nodes/YAMLMap.d.ts:49

toString

toString(
    ctx?: StringifyContext,
    onComment?: () => void,
    onChompKeep?: () => void,
): string
Parameters
- Optionalctx: StringifyContext
- OptionalonComment: () => void
- OptionalonChompKeep: () => void
Returns string
Overrides <internal>.toString
- Defined in node_modules/yaml/dist/nodes/YAMLMap.d.ts:52

`Static`from

from(schema: Schema, obj: unknown, ctx: CreateNodeContext): YAMLMap
A generic collection parsing method that can be extended to other node classes that inherit from YAMLMap
Parameters
- schema: Schema
- obj: unknown
- ctx: CreateNodeContext
Returns YAMLMap
- Defined in node_modules/yaml/dist/nodes/YAMLMap.d.ts:27

Class YAMLMap<K, V>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns YAMLMap<K, V>

Properties

[NODE_TYPE]

OptionaladdToJSMap

Optionalanchor

Optionalcomment

OptionalcommentBefore

Optionalflow

items

Optionalrange

schema

OptionalspaceBefore

OptionalsrcToken

Optionaltag

Accessors

StatictagName

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

Methods

add

Parameters

Returns void

addIn

Parameters

Returns void

clone

Parameters

Returns Collection

delete

Parameters

Returns boolean

deleteIn

Parameters

Returns boolean

get

Parameters

Returns Scalar<V>

Parameters

Returns V

Parameters

Returns V | Scalar<V>

getIn

Parameters

Returns unknown

has

Parameters

Returns boolean

hasAllNullValues

Parameters

Returns boolean

hasIn

Parameters

Returns boolean

set

Parameters

Returns void

setIn

Parameters

Returns void

toJS

Parameters

Returns any

toJSON

Type Parameters

Parameters

Returns any

toString

Parameters

Returns string

`Optional`addToJSMap

`Optional`anchor

`Optional`comment

`Optional`commentBefore

`Optional`flow

`Optional`range

`Optional`spaceBefore

`Optional`srcToken

`Optional`tag

`Static`tagName

`Static`from