YamlAlias
Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Alias.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.
Extends
Section titled “Extends”NodeBase
Extended by
Section titled “Extended by”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new YamlAlias(
source):Alias
Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Alias.d.ts:21
Parameters
Section titled “Parameters”source
Section titled “source”string
Returns
Section titled “Returns”Alias
Overrides
Section titled “Overrides”NodeBase.constructor
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/Node.d.ts:22
Inherited from
Section titled “Inherited from”NodeBase.[NODE_TYPE]
addToJSMap?
Section titled “addToJSMap?”
optionaladdToJSMap?: (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
Section titled “Parameters”YamlToJsContext | undefined
MapLike
unknown
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”NodeBase.addToJSMap
anchor?
Section titled “anchor?”
optionalanchor?:undefined
Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Alias.d.ts:20
comment?
Section titled “comment?”
optionalcomment?: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
Section titled “Inherited from”NodeBase.comment
commentBefore?
Section titled “commentBefore?”
optionalcommentBefore?: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
Section titled “Inherited from”NodeBase.commentBefore
range?
Section titled “range?”
optionalrange?: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
Section titled “Inherited from”NodeBase.range
source
Section titled “source”source:
string
Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Alias.d.ts:19
spaceBefore?
Section titled “spaceBefore?”
optionalspaceBefore?: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
Section titled “Inherited from”NodeBase.spaceBefore
srcToken?
Section titled “srcToken?”
optionalsrcToken?: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
Section titled “Inherited from”NodeBase.srcToken
optionaltag?: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
Section titled “Inherited from”NodeBase.tag
Methods
Section titled “Methods”clone()
Section titled “clone()”clone():
NodeBase
Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Node.d.ts:50
Create a copy of this node.
Returns
Section titled “Returns”NodeBase
Inherited from
Section titled “Inherited from”NodeBase.clone
resolve()
Section titled “resolve()”resolve(
doc,ctx?):YamlScalar<unknown> |YamlMap<unknown,unknown> |YamlSeq<unknown> |undefined
Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Alias.d.ts:26
Resolve the value of this alias within doc, finding the last
instance of the source anchor before this node.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”YamlScalar<unknown> | YamlMap<unknown, unknown> | YamlSeq<unknown> | undefined
toJS()
Section titled “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
Section titled “Parameters”YamlDocument<YamlNode<unknown>, boolean>
__namedParameters?
Section titled “__namedParameters?”ToJSOptions
Returns
Section titled “Returns”any
Inherited from
Section titled “Inherited from”NodeBase.toJS
toJSON()
Section titled “toJSON()”toJSON(
_arg?,ctx?):unknown
Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Alias.d.ts:27
A plain JS representation of this node
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”unknown
Overrides
Section titled “Overrides”NodeBase.toJSON
toString()
Section titled “toString()”toString(
ctx?,_onComment?,_onChompKeep?):string
Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Alias.d.ts:28
Parameters
Section titled “Parameters”_onComment?
Section titled “_onComment?”() => void
_onChompKeep?
Section titled “_onChompKeep?”() => void
Returns
Section titled “Returns”string
Overrides
Section titled “Overrides”NodeBase.toString