Parsed

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/doc/Document.d.ts:15

Ts-ignore

The typing of directives fails in TS <= 4.2

Extends

YamlDocument<Contents, Strict>

Type Parameters

Contents extends YamlParsedNode = YamlParsedNode

Strict

Strict extends boolean = true

Properties

[NODE_TYPE]

readonly [NODE_TYPE]: symbol

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

Inherited from

YamlDocument.[NODE_TYPE]

comment

comment: string | null

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/doc/Document.d.ts:25

A comment immediately after this Document

Inherited from

YamlDocument.comment

commentBefore

commentBefore: string | null

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

A comment before this Document

Inherited from

YamlDocument.commentBefore

contents: Strict extends true ? Contents | null : Contents

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

The document contents.

Inherited from

YamlDocument.contents

directives

directives: Directives

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

Overrides

YamlDocument.directives

errors

errors: YAMLError[]

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/doc/Document.d.ts:30

Errors encountered during parsing.

Inherited from

YamlDocument.errors

options

options: Required<Omit<ParseOptions & DocumentOptions, "_directives" | "lineCounter" | "version">>

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/doc/Document.d.ts:31

Inherited from

YamlDocument.options

range

range: YamlRange

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/doc/Document.d.ts:17

The [start, value-end, node-end] character offsets for the part of the source parsed into this document (undefined if not parsed). The value-end and node-end positions are themselves not included in their respective ranges.

Overrides

YamlDocument.range

schema

schema: YamlSchema

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

The schema used with the document. Use setSchema() to change.

Inherited from

YamlDocument.schema

warnings

warnings: YAMLWarning[]

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

Warnings encountered during parsing.

Inherited from

YamlDocument.warnings

Methods

add()

add(value): void

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

Adds a value to the document.

Parameters

value

any

Returns

void

Inherited from

YamlDocument.add

addIn()

addIn(path, value): void

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/doc/Document.d.ts:58

Adds a value to the document.

Parameters

path

Iterable<unknown>

value

unknown

Returns

void

Inherited from

YamlDocument.addIn

clone()

clone(): YamlDocument<Contents, Strict>

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/doc/Document.d.ts:54

Create a deep copy of this Document and its contents.

Custom Node values that inherit from Object still refer to their original instances.

Returns

YamlDocument<Contents, Strict>

Inherited from

YamlDocument.clone

createAlias()

createAlias(node, name?): YamlAlias

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/doc/Document.d.ts:68

Create a new Alias node, ensuring that the target node has the required anchor.

If node already has an anchor, name is ignored. Otherwise, the node.anchor value will be set to name, or if an anchor with that name is already present in the document, name will be used as a prefix for a new unique anchor. If name is undefined, the generated anchor will use ‘a’ as a prefix.

Parameters

node

Strict extends true ? YamlScalar<unknown> | YamlMap<unknown, unknown> | YamlSeq<unknown> : YamlNode

name?

string

Returns

YamlAlias

Inherited from

YamlDocument.createAlias

createNode()

Call Signature

createNode<T>(value, options?): NodeType<T>

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/doc/Document.d.ts:73

Convert any value into a Node using the current schema, recursively turning objects into collections.

Type Parameters

T

T = unknown

Parameters

value

T

options?

CreateNodeOptions

Returns

NodeType<T>

Inherited from

YamlDocument.createNode

Call Signature

createNode<T>(value, replacer, options?): NodeType<T>

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/doc/Document.d.ts:74

Convert any value into a Node using the current schema, recursively turning objects into collections.

Type Parameters

T

T = unknown

Parameters

value

T

replacer

CreateNodeOptions | Replacer | null

options?

CreateNodeOptions

Returns

NodeType<T>

Inherited from

YamlDocument.createNode

createPair()

createPair<K, V>(key, value, options?): YamlPair<K, V>

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/doc/Document.d.ts:79

Convert a key and a value into a Pair using the current schema, recursively wrapping all values as Scalar or Collection nodes.

Type Parameters

K

K extends YamlNode = YamlNode

V

V extends YamlNode = YamlNode

Parameters

key

unknown

value

unknown

options?

CreateNodeOptions

Returns

YamlPair<K, V>

Inherited from

YamlDocument.createPair

delete()

delete(key): boolean

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/doc/Document.d.ts:84

Removes a value from the document.

Parameters

key

unknown

Returns

boolean

true if the item was found and removed.

Inherited from

YamlDocument.delete

deleteIn()

deleteIn(path): boolean

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/doc/Document.d.ts:89

Removes a value from the document.

Parameters

path

Iterable<unknown, any, any> | null

Returns

boolean

true if the item was found and removed.

Inherited from

YamlDocument.deleteIn

get()

get(key, keepScalar?): Strict extends true ? unknown : any

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/doc/Document.d.ts:95

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?

boolean

Returns

Strict extends true ? unknown : any

Inherited from

YamlDocument.get

getIn()

getIn(path, keepScalar?): Strict extends true ? unknown : any

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/doc/Document.d.ts:101

Returns item at path, 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, any, any> | null

keepScalar?

boolean

Returns

Strict extends true ? unknown : any

Inherited from

YamlDocument.getIn

has()

has(key): boolean

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/doc/Document.d.ts:105

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

Parameters

key

unknown

Returns

boolean

Inherited from

YamlDocument.has

hasIn()

hasIn(path): boolean

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/doc/Document.d.ts:109

Checks if the document includes a value at path.

Parameters

path

Iterable<unknown, any, any> | null

Returns

boolean

Inherited from

YamlDocument.hasIn

set()

set(key, value): void

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/doc/Document.d.ts:114

Sets a value in this document. For !!set, value needs to be a boolean to add/remove the item from the set.

Parameters

key

any

value

unknown

Returns

void

Inherited from

YamlDocument.set

setIn()

setIn(path, value): void

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/doc/Document.d.ts:119

Sets a value in this document. For !!set, value needs to be a boolean to add/remove the item from the set.

Parameters

path

Iterable<unknown, any, any> | null

value

unknown

Returns

void

Inherited from

YamlDocument.setIn

setSchema()

setSchema(version, options?): void

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/doc/Document.d.ts:127

Change the YAML version and schema used by the document. A null version disables support for directives, explicit tags, anchors, and aliases. It also requires the schema option to be given as a Schema instance value.

Overrides all previously set schema options.

Parameters

version

"1.1" | "1.2" | "next" | null

options?

SchemaOptions

Returns

void

Inherited from

YamlDocument.setSchema

toJS()

toJS(opt?): any

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/doc/Document.d.ts:129

A plain JavaScript representation of the document contents.

Parameters

opt?

ToJSOptions & object

Returns

any

Inherited from

YamlDocument.toJS

toJSON()

toJSON(jsonArg?, onAnchor?): any

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/doc/Document.d.ts:138

A JSON representation of the document contents.

Parameters

jsonArg?

string | null

Used by JSON.stringify to indicate the array index or property name.

onAnchor?

(value, count) => void

Returns

any

Inherited from

YamlDocument.toJSON

toString()

toString(options?): string

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/doc/Document.d.ts:140

A YAML representation of the document.

Parameters

options?

ToStringOptions

Returns

string

Inherited from

YamlDocument.toString