Parsed

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

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

• YamlAlias

Properties

[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

YamlAlias.[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

YamlAlias.addToJSMap

---

anchor?

optional anchor?: undefined

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

Inherited from

YamlAlias.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

Parsed.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

Parsed.commentBefore

---

range

range: YamlRange

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

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.

Overrides

YamlMap.range

---

source

source: string

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

Inherited from

YamlAlias.source

---

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

YamlAlias.spaceBefore

---

srcToken?

optional srcToken?: FlowScalar & object

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

The CST token that was composed into this node.

Type Declaration

type

type: "alias"

Overrides

YamlAlias.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

YamlAlias.tag

Methods

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

NodeBase

Inherited from

YamlAlias.clone

---

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

doc

YamlDocument

ctx?

YamlToJsContext

Returns

YamlScalar<unknown> | YamlMap<unknown, unknown> | YamlSeq<unknown> | undefined

Inherited from

YamlAlias.resolve

---

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

YamlAlias.toJS

---

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

_arg?

unknown

ctx?

YamlToJsContext

Returns

unknown

Inherited from

YamlAlias.toJSON

---

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

ctx?

YamlStringifyContext

_onComment?

() => void

_onChompKeep?

() => void

Returns

string

Inherited from

YamlAlias.toString