Class Document<T>

constructor

• new Document<T>(value?, options?): yaml.Document<T>

• Type Parameters

  • T extends yaml.Node = yaml.Node

  Parameters

  • Optionalvalue: any

    The initial value for the document, which will be wrapped in a Node container.
  • Optionaloptions: DocumentOptions & SchemaOptions & ParseOptions & CreateNodeOptions

  Returns yaml.Document<T>
• new Document<T>(value, replacer, options?): yaml.Document<T>

• Type Parameters

  • T extends yaml.Node = yaml.Node

  Parameters

  • value: any
  • replacer: null | Replacer
  • Optionaloptions: DocumentOptions & SchemaOptions & ParseOptions & CreateNodeOptions

  Returns yaml.Document<T>

Readonly[NODE_TYPE]

comment

commentBefore

contents

Optionaldirectives

errors

options

Optionalrange

schema

warnings

add

• add(value): void

• Adds a value to the document.

  Parameters

  • value: any

  Returns void

addIn

• addIn(path, value): void

• Adds a value to the document.

  Parameters

  • path: Iterable<unknown>
  • value: unknown

  Returns void

clone

• clone(): yaml.Document<T>

• Create a deep copy of this Document and its contents.

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

  Returns yaml.Document<T>

createAlias

• createAlias(node, name?): Alias

• 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: Scalar<unknown> | YAMLMap<unknown, unknown> | YAMLSeq<unknown>
  • Optionalname: string

  Returns Alias

createNode

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

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

  Type Parameters

  • T = unknown

  Parameters

  • value: T
  • Optionaloptions: CreateNodeOptions

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

• Type Parameters

  • T = unknown

  Parameters

  • value: T
  • replacer: null | CreateNodeOptions | Replacer
  • Optionaloptions: CreateNodeOptions

  Returns NodeType<T>

createPair

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

• 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 extends yaml.Node = yaml.Node
  • V extends yaml.Node = yaml.Node

  Parameters

  • key: unknown
  • value: unknown
  • Optionaloptions: CreateNodeOptions

  Returns Pair<K, V>

delete

• delete(key): boolean

• Removes a value from the document.

  Parameters

  • key: unknown

  Returns boolean

  true if the item was found and removed.

deleteIn

• deleteIn(path): boolean

• Removes a value from the document.

  Parameters

  • path: null | Iterable<unknown>

  Returns boolean

  true if the item was found and removed.

get

• get(key, keepScalar?): unknown

• 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
  • OptionalkeepScalar: boolean

  Returns unknown

getIn

• getIn(path, keepScalar?): unknown

• 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: null | Iterable<unknown>
  • OptionalkeepScalar: boolean

  Returns unknown

has

• has(key): boolean

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

  Parameters

  • key: unknown

  Returns boolean

hasIn

• hasIn(path): boolean

• Checks if the document includes a value at path.

  Parameters

  • path: null | Iterable<unknown>

  Returns boolean

set

• set(key, value): void

• 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

setIn

• setIn(path, value): void

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

  Parameters

  • path: null | Iterable<unknown>
  • value: unknown

  Returns void

setSchema

• setSchema(version, options?): void

• 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:
        | null
        | "next"
        | "1.2"
        | "1.1"
  • Optionaloptions: SchemaOptions

  Returns void

toJS

• toJS(opt?): any

• A plain JavaScript representation of the document contents.

  Parameters

  • Optionalopt: ToJSOptions & {
        [ignored: string]: unknown;
    }

  Returns any

toJSON

• toJSON(jsonArg?, onAnchor?): any

• A JSON representation of the document contents.

  Parameters

  • OptionaljsonArg: null | string

    Used by JSON.stringify to indicate the array index or property name.
  • OptionalonAnchor: ((value: unknown, count: number) => void)
    • • (value, count): void

      • Parameters

        • value: unknown
        • count: number

        Returns void

  Returns any

toString

• toString(options?): string

• A YAML representation of the document.

  Parameters

  • Optionaloptions: ToStringOptions

  Returns string