YamlPair
Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Pair.d.ts:10
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.
Type Parameters
Section titled “Type Parameters”K = unknown
V = unknown
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new YamlPair<
K,V>(key,value?):Pair<K,V>
Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Pair.d.ts:18
Parameters
Section titled “Parameters”K
value?
Section titled “value?”V | null
Returns
Section titled “Returns”Pair<K, V>
Properties
Section titled “Properties”[NODE_TYPE]
Section titled “[NODE_TYPE]”
readonly[NODE_TYPE]:symbol
Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Pair.d.ts:11
key:
K
Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Pair.d.ts:13
Always Node or null when parsed, but can be set to anything.
srcToken?
Section titled “srcToken?”
optionalsrcToken?:CollectionItem
Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Pair.d.ts:17
The CST token that was composed into this pair.
value:
V|null
Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Pair.d.ts:15
Always Node or null when parsed, but can be set to anything.
Methods
Section titled “Methods”clone()
Section titled “clone()”clone(
schema?):Pair<K,V>
Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Pair.d.ts:19
Parameters
Section titled “Parameters”schema?
Section titled “schema?”Returns
Section titled “Returns”Pair<K, V>
toJSON()
Section titled “toJSON()”toJSON(
_?,ctx?):MapLike
Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Pair.d.ts:20
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”MapLike
toString()
Section titled “toString()”toString(
ctx?,onComment?,onChompKeep?):string
Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Pair.d.ts:21
Parameters
Section titled “Parameters”onComment?
Section titled “onComment?”() => void
onChompKeep?
Section titled “onChompKeep?”() => void
Returns
Section titled “Returns”string