Interface Parsed<T>

interface Parsed<T> {
    [NODE_TYPE]: symbol;
    comment: null | string;
    commentBefore: null | string;
    contents: null | T;
    directives: Directives;
    errors: YAMLError[];
    options: Required<Omit<ParseOptions & DocumentOptions, "version" | "_directives" | "lineCounter">>;
    range: Range;
    schema: yaml.Schema;
    warnings: YAMLWarning[];
    add(value: any): void;
    addIn(path: Iterable<unknown>, value: unknown): void;
    clone(): yaml.Document<T>;
    createAlias(node: Scalar<unknown> | YAMLMap<unknown, unknown> | YAMLSeq<unknown>, name?: string): Alias;
    createNode<T>(value: T, options?: CreateNodeOptions): NodeType<T>;
    createNode<T>(value: T, replacer: null | CreateNodeOptions | Replacer, options?: CreateNodeOptions): NodeType<T>;
    createPair<K, V>(key: unknown, value: unknown, options?: CreateNodeOptions): Pair<K, V>;
    delete(key: unknown): boolean;
    deleteIn(path: null | Iterable<unknown>): boolean;
    get(key: unknown, keepScalar?: boolean): unknown;
    getIn(path: null | Iterable<unknown>, keepScalar?: boolean): unknown;
    has(key: unknown): boolean;
    hasIn(path: null | Iterable<unknown>): boolean;
    set(key: any, value: unknown): void;
    setIn(path: null | Iterable<unknown>, value: unknown): void;
    setSchema(version:
        | null
        | "next"
        | "1.2"
        | "1.1", options?: SchemaOptions): void;
    toJS(opt?: ToJSOptions & {
        [ignored: string]: unknown;
    }): any;
    toJSON(jsonArg?: null | string, onAnchor?: ((value: unknown, count: number) => void)): any;
    toString(options?: ToStringOptions): string;
}

Type Parameters

Hierarchy (view full)

Properties

[NODE_TYPE] comment commentBefore contents directives errors options range schema warnings

Methods

add addIn clone createAlias createNode createPair delete deleteIn get getIn has hasIn set setIn setSchema toJS toJSON toString

Properties

Readonly[NODE_TYPE]

[NODE_TYPE]: symbol

comment

comment: null | string

A comment immediately after this Document

commentBefore

commentBefore: null | string

A comment before this Document

contents

contents: null | T

The document contents.

directives

directives: Directives

errors

errors: YAMLError[]

Errors encountered during parsing.

options

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

range

range: Range

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.

schema

schema: yaml.Schema

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

warnings

warnings: YAMLWarning[]

Warnings encountered during parsing.

Methods

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

    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

    Returns NodeType<T>

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

  • Type Parameters

    • T = unknown

    Parameters

    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

    Parameters

    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

    Returns string

Settings

Member Visibility

On This Page

Properties
Methods