Class Document<Contents, Strict>

constructor

• new Document<Contents extends Node = Node, Strict extends boolean = true>(
      value?: any,
      options?: DocumentOptions & SchemaOptions & ParseOptions & CreateNodeOptions,
  ): Document<Contents, Strict>

  Type Parameters

  • Contents extends Node = Node
  • Strict extends boolean = true

  Parameters

  • Optionalvalue: any

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

  Returns Document<Contents, Strict>
• new Document<Contents extends Node = Node, Strict extends boolean = true>(
      value: any,
      replacer: Replacer,
      options?: DocumentOptions & SchemaOptions & ParseOptions & CreateNodeOptions,
  ): Document<Contents, Strict>

  Type Parameters

  • Contents extends Node = Node
  • Strict extends boolean = true

  Parameters

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

  Returns Document<Contents, Strict>

Readonly[NODE_TYPE]

comment

commentBefore

contents

directives

errors

options

Optionalrange

schema

warnings

add

• add(value: any): void

  Adds a value to the document.

  Parameters

  • value: any

  Returns void

addIn

• addIn(path: Iterable<unknown>, value: unknown): void

  Adds a value to the document.

  Parameters

  • path: Iterable<unknown>
  • value: unknown

  Returns void

clone

• clone(): Document<Contents, Strict>

  Create a deep copy of this Document and its contents.

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

  Returns Document<Contents, Strict>

createAlias

• createAlias(
      node: Strict extends true
          ? Scalar<unknown>
          | YAMLMap<unknown, unknown>
          | YAMLSeq<unknown>
          : Node,
      name?: string,
  ): 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: Strict extends true
        ? Scalar<unknown>
        | YAMLMap<unknown, unknown>
        | YAMLSeq<unknown>
        : Node
  • Optionalname: string

  Returns Alias

createNode

• createNode<T = unknown>(value: T, options?: CreateNodeOptions): 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 = unknown>(
      value: T,
      replacer: Replacer | CreateNodeOptions,
      options?: CreateNodeOptions,
  ): NodeType<T>

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

  Type Parameters

  • T = unknown

  Parameters

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

  Returns NodeType<T>

createPair

• createPair<K extends Node = Node, V extends Node = Node>(
      key: unknown,
      value: unknown,
      options?: CreateNodeOptions,
  ): 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 Node = Node
  • V extends Node = Node

  Parameters

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

  Returns Pair<K, V>

delete

• delete(key: unknown): boolean

  Removes a value from the document.

  Parameters

  • key: unknown

  Returns boolean

  true if the item was found and removed.

deleteIn

• deleteIn(path: Iterable<unknown, any, any>): boolean

  Removes a value from the document.

  Parameters

  • path: Iterable<unknown, any, any>

  Returns boolean

  true if the item was found and removed.

get

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

  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 Strict extends true ? unknown : any

getIn

• getIn(
      path: Iterable<unknown, any, any>,
      keepScalar?: boolean,
  ): Strict extends true ? unknown : any

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

  Returns Strict extends true ? unknown : any

has

• has(key: unknown): boolean

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

  Parameters

  • key: unknown

  Returns boolean

hasIn

• hasIn(path: Iterable<unknown, any, any>): boolean

  Checks if the document includes a value at path.

  Parameters

  • path: Iterable<unknown, any, any>

  Returns boolean

set

• set(key: any, value: unknown): 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: Iterable<unknown, any, any>, value: unknown): 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: Iterable<unknown, any, any>
  • value: unknown

  Returns void

setSchema

• setSchema(version: "1.1" | "1.2" | "next", options?: SchemaOptions): 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: "1.1" | "1.2" | "next"
  • Optionaloptions: SchemaOptions

  Returns void

toJS

• toJS(opt?: ToJSOptions & { [ignored: string]: unknown }): any

  A plain JavaScript representation of the document contents.

  Parameters

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

  Returns any

toJSON

• toJSON(
      jsonArg?: string,
      onAnchor?: (value: unknown, count: number) => void,
  ): any

  A JSON representation of the document contents.

  Parameters

  • OptionaljsonArg: string

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

  Returns any

toString

• toString(options?: ToStringOptions): string

  A YAML representation of the document.

  Parameters

  • Optionaloptions: ToStringOptions

  Returns string