YamlMap

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/YAMLMap.d.ts:12

The yaml node, tag and visitor model, re-exported so a caller can write a custom tag without taking its own dependency on yaml.

Names are Yaml-prefixed rather than kept as upstream. This package’s index is a flat export *, so a bare Node, Document, Scalar or Schema would sit beside YamlParseStream and parseYaml under names that say nothing about YAML — and Node and Document are DOM globals, which this package, being portable, is expected to be imported alongside.

Extends

Collection

Extended by

Parsed

Type Parameters

K

K = unknown

V

V = unknown

Constructors

Constructor

new YamlMap<K, V>(schema?): YAMLMap<K, V>

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/YAMLMap.d.ts:22

Parameters

schema?

YamlSchema

Returns

YAMLMap<K, V>

Overrides

Collection.constructor

Properties

[NODE_TYPE]

[NODE_TYPE]: symbol

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Collection.d.ts:8

Inherited from

Collection.[NODE_TYPE]

addToJSMap?

optional addToJSMap?: (ctx, map, value) => void

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Node.d.ts:44

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

Parameters

ctx

YamlToJsContext | undefined

map

MapLike

value

unknown

Returns

void

Inherited from

Collection.addToJSMap

anchor?

optional anchor?: string

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Collection.d.ts:11

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

Inherited from

Collection.anchor

comment?

optional comment?: string | null

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Node.d.ts:24

A comment on or immediately after this

Inherited from

Collection.comment

commentBefore?

optional commentBefore?: string | null

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Node.d.ts:26

A comment before this

Inherited from

Collection.commentBefore

flow?

optional flow?: boolean

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Collection.d.ts:16

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

Inherited from

Collection.flow

items

items: YamlPair<K, V>[]

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/YAMLMap.d.ts:21

Overrides

Collection.items

range?

optional range?: YamlRange | null

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Node.d.ts:33

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.

Inherited from

Collection.range

schema

schema: YamlSchema | undefined

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Collection.d.ts:7

Inherited from

Collection.schema

spaceBefore?

optional spaceBefore?: boolean

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Node.d.ts:35

A blank line before this node and its commentBefore

Inherited from

Collection.spaceBefore

srcToken?

optional srcToken?: Token

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Node.d.ts:37

The CST token that was composed into this node.

Inherited from

Collection.srcToken

tag?

optional tag?: string

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Node.d.ts:39

A fully qualified tag, if required

Inherited from

Collection.tag

Accessors

tagName

Get Signature

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

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/YAMLMap.d.ts:20

Returns

"tag:yaml.org,2002:map"

Methods

add()

add(pair, overwrite?): void

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/YAMLMap.d.ts:34

Adds a value to the collection.

Parameters

pair

YamlPair<K, V> | { key: K; value: V; }

overwrite?

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

addIn()

addIn(path, value): void

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Collection.d.ts:51

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

clone()

clone(schema?): Collection

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Collection.d.ts:23

Create a copy of this collection.

Parameters

schema?

YamlSchema

If defined, overwrites the original’s schema

Returns

Collection

Inherited from

Collection.clone

delete()

delete(key): boolean

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/YAMLMap.d.ts:38

Removes a value from the collection.

Parameters

key

unknown

Returns

boolean

true if the item was found and removed.

Overrides

Collection.delete

deleteIn()

deleteIn(path): boolean

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Collection.d.ts:56

Removes a value from the collection.

Parameters

path

Iterable<unknown>

Returns

boolean

true if the item was found and removed.

Inherited from

Collection.deleteIn

get()

Call Signature

get(key, keepScalar): YamlScalar<V> | undefined

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/YAMLMap.d.ts:39

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

YamlScalar<V> | undefined

Overrides

Collection.get

Call Signature

get(key, keepScalar?): V | undefined

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/YAMLMap.d.ts:40

Parameters

key

unknown

keepScalar?

false

Returns

V | undefined

Overrides

Collection.get

Call Signature

get(key, keepScalar?): V | YamlScalar<V> | undefined

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/YAMLMap.d.ts:41

Parameters

key

unknown

keepScalar?

boolean

Returns

V | YamlScalar<V> | undefined

Overrides

Collection.get

getIn()

getIn(path, keepScalar?): unknown

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Collection.d.ts:62

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>

keepScalar?

boolean

Returns

unknown

Inherited from

Collection.getIn

has()

has(key): boolean

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/YAMLMap.d.ts:42

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

Parameters

key

unknown

Returns

boolean

Overrides

Collection.has

hasAllNullValues()

hasAllNullValues(allowScalar?): boolean

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Collection.d.ts:63

Parameters

allowScalar?

boolean

Returns

boolean

Inherited from

Collection.hasAllNullValues

hasIn()

hasIn(path): boolean

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Collection.d.ts:67

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

Parameters

path

Iterable<unknown>

Returns

boolean

Inherited from

Collection.hasIn

set()

set(key, value): void

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/YAMLMap.d.ts:43

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

setIn()

setIn(path, value): void

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Collection.d.ts:72

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

toJS()

toJS(doc, __namedParameters?): any

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Node.d.ts:52

A plain JavaScript representation of this node.

Parameters

doc

YamlDocument<YamlNode<unknown>, boolean>

__namedParameters?

ToJSOptions

Returns

any

Inherited from

Collection.toJS

toJSON()

toJSON<T>(_?, ctx?, Type?): any

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/YAMLMap.d.ts:49

Type Parameters

T

T extends MapLike = Map<unknown, unknown>

Parameters

_?

unknown

ctx?

YamlToJsContext

Conversion context, originally set in Document#toJS()

Type?

() => T

If set, forces the returned collection type

Returns

any

Instance of Type, Map, or Object

Overrides

Collection.toJSON

toString()

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

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/YAMLMap.d.ts:52

Parameters

ctx?

YamlStringifyContext

onComment?

() => void

onChompKeep?

() => void

Returns

string

Overrides

Collection.toString

from()

static from(schema, obj, ctx): YAMLMap

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/YAMLMap.d.ts:27

A generic collection parsing method that can be extended to other node classes that inherit from YAMLMap

Parameters

schema

YamlSchema

obj

unknown

ctx

YamlCreateNodeContext

Returns

YAMLMap