interface EmptyStream {
    [unscopables]: {
        [unscopables]?: boolean;
        length?: boolean;
        [iterator]?: any;
        at?: any;
        concat?: any;
        copyWithin?: any;
        entries?: any;
        every?: any;
        fill?: any;
        filter?: any;
        find?: any;
        findIndex?: any;
        findLast?: any;
        findLastIndex?: any;
        flat?: any;
        flatMap?: any;
        forEach?: any;
        includes?: any;
        indexOf?: any;
        join?: any;
        keys?: any;
        lastIndexOf?: any;
        map?: any;
        pop?: any;
        push?: any;
        reduce?: any;
        reduceRight?: any;
        reverse?: any;
        shift?: any;
        slice?: any;
        some?: any;
        sort?: any;
        splice?: any;
        toLocaleString?: any;
        toReversed?: any;
        toSorted?: any;
        toSpliced?: any;
        toString?: any;
        unshift?: any;
        values?: any;
        with?: any;
    };
    comment: string;
    directives: Directives;
    empty: true;
    errors: YAMLParseError[];
    length: number;
    warnings: YAMLWarning[];
    [iterator](): IterableIterator<yaml.Document.Parsed<ParsedNode>>;
    at(index: number): undefined | yaml.Document.Parsed<ParsedNode>;
    concat(...items: ConcatArray<yaml.Document.Parsed<ParsedNode>>[]): yaml.Document.Parsed<ParsedNode>[];
    concat(...items: (yaml.Document.Parsed<ParsedNode> | ConcatArray<yaml.Document.Parsed<ParsedNode>>)[]): yaml.Document.Parsed<ParsedNode>[];
    copyWithin(target: number, start: number, end?: number): this;
    entries(): IterableIterator<[number, yaml.Document.Parsed<ParsedNode>]>;
    every<S>(predicate: ((value: yaml.Document.Parsed<ParsedNode>, index: number, array: yaml.Document.Parsed<ParsedNode>[]) => value is S), thisArg?: any): this is S[];
    every(predicate: ((value: yaml.Document.Parsed<ParsedNode>, index: number, array: yaml.Document.Parsed<ParsedNode>[]) => unknown), thisArg?: any): boolean;
    fill(value: yaml.Document.Parsed<ParsedNode>, start?: number, end?: number): this;
    filter<S>(predicate: ((value: yaml.Document.Parsed<ParsedNode>, index: number, array: yaml.Document.Parsed<ParsedNode>[]) => value is S), thisArg?: any): S[];
    filter(predicate: ((value: yaml.Document.Parsed<ParsedNode>, index: number, array: yaml.Document.Parsed<ParsedNode>[]) => unknown), thisArg?: any): yaml.Document.Parsed<ParsedNode>[];
    find<S>(predicate: ((value: yaml.Document.Parsed<ParsedNode>, index: number, obj: yaml.Document.Parsed<ParsedNode>[]) => value is S), thisArg?: any): undefined | S;
    find(predicate: ((value: yaml.Document.Parsed<ParsedNode>, index: number, obj: yaml.Document.Parsed<ParsedNode>[]) => unknown), thisArg?: any): undefined | yaml.Document.Parsed<ParsedNode>;
    findIndex(predicate: ((value: yaml.Document.Parsed<ParsedNode>, index: number, obj: yaml.Document.Parsed<ParsedNode>[]) => unknown), thisArg?: any): number;
    findLast<S>(predicate: ((value: yaml.Document.Parsed<ParsedNode>, index: number, array: yaml.Document.Parsed<ParsedNode>[]) => value is S), thisArg?: any): undefined | S;
    findLast(predicate: ((value: yaml.Document.Parsed<ParsedNode>, index: number, array: yaml.Document.Parsed<ParsedNode>[]) => unknown), thisArg?: any): undefined | yaml.Document.Parsed<ParsedNode>;
    findLastIndex(predicate: ((value: yaml.Document.Parsed<ParsedNode>, index: number, array: yaml.Document.Parsed<ParsedNode>[]) => unknown), thisArg?: any): number;
    flat<A, D>(this: A, depth?: D): FlatArray<A, D>[];
    flatMap<U, This>(callback: ((this: This, value: yaml.Document.Parsed<ParsedNode>, index: number, array: yaml.Document.Parsed<ParsedNode>[]) => U | readonly U[]), thisArg?: This): U[];
    forEach(callbackfn: ((value: yaml.Document.Parsed<ParsedNode>, index: number, array: yaml.Document.Parsed<ParsedNode>[]) => void), thisArg?: any): void;
    includes(searchElement: yaml.Document.Parsed<ParsedNode>, fromIndex?: number): boolean;
    indexOf(searchElement: yaml.Document.Parsed<ParsedNode>, fromIndex?: number): number;
    join(separator?: string): string;
    keys(): IterableIterator<number>;
    lastIndexOf(searchElement: yaml.Document.Parsed<ParsedNode>, fromIndex?: number): number;
    map<U>(callbackfn: ((value: yaml.Document.Parsed<ParsedNode>, index: number, array: yaml.Document.Parsed<ParsedNode>[]) => U), thisArg?: any): U[];
    pop(): undefined | yaml.Document.Parsed<ParsedNode>;
    push(...items: yaml.Document.Parsed<ParsedNode>[]): number;
    reduce(callbackfn: ((previousValue: yaml.Document.Parsed<ParsedNode>, currentValue: yaml.Document.Parsed<ParsedNode>, currentIndex: number, array: yaml.Document.Parsed<ParsedNode>[]) => yaml.Document.Parsed<ParsedNode>)): yaml.Document.Parsed<ParsedNode>;
    reduce(callbackfn: ((previousValue: yaml.Document.Parsed<ParsedNode>, currentValue: yaml.Document.Parsed<ParsedNode>, currentIndex: number, array: yaml.Document.Parsed<ParsedNode>[]) => yaml.Document.Parsed<ParsedNode>), initialValue: yaml.Document.Parsed<ParsedNode>): yaml.Document.Parsed<ParsedNode>;
    reduce<U>(callbackfn: ((previousValue: U, currentValue: yaml.Document.Parsed<ParsedNode>, currentIndex: number, array: yaml.Document.Parsed<ParsedNode>[]) => U), initialValue: U): U;
    reduceRight(callbackfn: ((previousValue: yaml.Document.Parsed<ParsedNode>, currentValue: yaml.Document.Parsed<ParsedNode>, currentIndex: number, array: yaml.Document.Parsed<ParsedNode>[]) => yaml.Document.Parsed<ParsedNode>)): yaml.Document.Parsed<ParsedNode>;
    reduceRight(callbackfn: ((previousValue: yaml.Document.Parsed<ParsedNode>, currentValue: yaml.Document.Parsed<ParsedNode>, currentIndex: number, array: yaml.Document.Parsed<ParsedNode>[]) => yaml.Document.Parsed<ParsedNode>), initialValue: yaml.Document.Parsed<ParsedNode>): yaml.Document.Parsed<ParsedNode>;
    reduceRight<U>(callbackfn: ((previousValue: U, currentValue: yaml.Document.Parsed<ParsedNode>, currentIndex: number, array: yaml.Document.Parsed<ParsedNode>[]) => U), initialValue: U): U;
    reverse(): yaml.Document.Parsed<ParsedNode>[];
    shift(): undefined | yaml.Document.Parsed<ParsedNode>;
    slice(start?: number, end?: number): yaml.Document.Parsed<ParsedNode>[];
    some(predicate: ((value: yaml.Document.Parsed<ParsedNode>, index: number, array: yaml.Document.Parsed<ParsedNode>[]) => unknown), thisArg?: any): boolean;
    sort(compareFn?: ((a: yaml.Document.Parsed<ParsedNode>, b: yaml.Document.Parsed<ParsedNode>) => number)): this;
    splice(start: number, deleteCount?: number): yaml.Document.Parsed<ParsedNode>[];
    splice(start: number, deleteCount: number, ...items: yaml.Document.Parsed<ParsedNode>[]): yaml.Document.Parsed<ParsedNode>[];
    toLocaleString(): string;
    toLocaleString(locales: string | string[], options?: NumberFormatOptions & DateTimeFormatOptions): string;
    toReversed(): yaml.Document.Parsed<ParsedNode>[];
    toSorted(compareFn?: ((a: yaml.Document.Parsed<ParsedNode>, b: yaml.Document.Parsed<ParsedNode>) => number)): yaml.Document.Parsed<ParsedNode>[];
    toSpliced(start: number, deleteCount: number, ...items: yaml.Document.Parsed<ParsedNode>[]): yaml.Document.Parsed<ParsedNode>[];
    toSpliced(start: number, deleteCount?: number): yaml.Document.Parsed<ParsedNode>[];
    toString(): string;
    unshift(...items: yaml.Document.Parsed<ParsedNode>[]): number;
    values(): IterableIterator<yaml.Document.Parsed<ParsedNode>>;
    with(index: number, value: yaml.Document.Parsed<ParsedNode>): yaml.Document.Parsed<ParsedNode>[];
}

Hierarchy

Properties

[unscopables]: {
    [unscopables]?: boolean;
    length?: boolean;
    [iterator]?: any;
    at?: any;
    concat?: any;
    copyWithin?: any;
    entries?: any;
    every?: any;
    fill?: any;
    filter?: any;
    find?: any;
    findIndex?: any;
    findLast?: any;
    findLastIndex?: any;
    flat?: any;
    flatMap?: any;
    forEach?: any;
    includes?: any;
    indexOf?: any;
    join?: any;
    keys?: any;
    lastIndexOf?: any;
    map?: any;
    pop?: any;
    push?: any;
    reduce?: any;
    reduceRight?: any;
    reverse?: any;
    shift?: any;
    slice?: any;
    some?: any;
    sort?: any;
    splice?: any;
    toLocaleString?: any;
    toReversed?: any;
    toSorted?: any;
    toSpliced?: any;
    toString?: any;
    unshift?: any;
    values?: any;
    with?: any;
}

Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Type declaration

  • Optional Readonly[unscopables]?: boolean

    Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

  • Optionallength?: boolean

    Gets or sets the length of the array. This is a number one higher than the highest index in the array.

comment: string
directives: Directives
empty: true
errors: YAMLParseError[]
length: number

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

warnings: YAMLWarning[]

Methods

  • Returns the item located at the specified index.

    Parameters

    • index: number

      The zero-based index of the desired code unit. A negative index will count back from the last item.

    Returns undefined | yaml.Document.Parsed<ParsedNode>

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optionalend: number

      If not specified, length of the this object is used as its default value.

    Returns this

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, yaml.Document.Parsed<ParsedNode>]>

  • Determines whether all the members of an array satisfy the specified test.

    Type Parameters

    Parameters

    • predicate: ((value: yaml.Document.Parsed<ParsedNode>, index: number, array: yaml.Document.Parsed<ParsedNode>[]) => value is S)

      A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns this is S[]

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • predicate: ((value: yaml.Document.Parsed<ParsedNode>, index: number, array: yaml.Document.Parsed<ParsedNode>[]) => unknown)

      A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

  • Changes all array elements from start to end index to a static value and returns the modified array

    Parameters

    • value: yaml.Document.Parsed<ParsedNode>

      value to fill array section with

    • Optionalstart: number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optionalend: number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type Parameters

    Parameters

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    Returns yaml.Document.Parsed<ParsedNode>[]

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: ((value: yaml.Document.Parsed<ParsedNode>, index: number, obj: yaml.Document.Parsed<ParsedNode>[]) => unknown)

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • OptionalthisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

  • Returns the index of the last element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: ((value: yaml.Document.Parsed<ParsedNode>, index: number, array: yaml.Document.Parsed<ParsedNode>[]) => unknown)

      findLastIndex calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLastIndex immediately returns that element index. Otherwise, findLastIndex returns -1.

    • OptionalthisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

  • Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

    Type Parameters

    • A
    • D extends number = 1

    Parameters

    • this: A
    • Optionaldepth: D

      The maximum recursion depth

    Returns FlatArray<A, D>[]

  • Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

    Type Parameters

    • U
    • This = undefined

    Parameters

    Returns U[]

  • Performs the specified action for each element in an array.

    Parameters

    Returns void

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: yaml.Document.Parsed<ParsedNode>

      The element to search for.

    • OptionalfromIndex: number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

  • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

    Parameters

    • searchElement: yaml.Document.Parsed<ParsedNode>

      The value to locate in the array.

    • OptionalfromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

  • Adds all the elements of an array into a string, separated by the specified separator string.

    Parameters

    • Optionalseparator: string

      A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.

    Returns string

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

  • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

    Parameters

    • searchElement: yaml.Document.Parsed<ParsedNode>

      The value to locate in the array.

    • OptionalfromIndex: number

      The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type Parameters

    • U

    Parameters

    Returns U[]

  • Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

    Returns undefined | yaml.Document.Parsed<ParsedNode>

  • Appends new elements to the end of an array, and returns the new length of the array.

    Parameters

    Returns number

  • Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.

    Returns yaml.Document.Parsed<ParsedNode>[]

  • Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

    Returns undefined | yaml.Document.Parsed<ParsedNode>

  • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

    Parameters

    • Optionalstart: number

      The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.

    • Optionalend: number

      The end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array.

    Returns yaml.Document.Parsed<ParsedNode>[]

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • predicate: ((value: yaml.Document.Parsed<ParsedNode>, index: number, array: yaml.Document.Parsed<ParsedNode>[]) => unknown)

      A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

  • Sorts an array in place. This method mutates the array and returns a reference to the same array.

    Parameters

    Returns this

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • OptionaldeleteCount: number

      The number of elements to remove.

    Returns yaml.Document.Parsed<ParsedNode>[]

    An array containing the elements that were deleted.

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest...items: yaml.Document.Parsed<ParsedNode>[]

      Elements to insert into the array in place of the deleted elements.

    Returns yaml.Document.Parsed<ParsedNode>[]

    An array containing the elements that were deleted.

  • Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

    Returns string

  • Parameters

    • locales: string | string[]
    • Optionaloptions: NumberFormatOptions & DateTimeFormatOptions

    Returns string

  • Copies an array and removes elements and, if necessary, inserts new elements in their place. Returns the copied array.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest...items: yaml.Document.Parsed<ParsedNode>[]

      Elements to insert into the copied array in place of the deleted elements.

    Returns yaml.Document.Parsed<ParsedNode>[]

    The copied array.

  • Copies an array and removes elements while returning the remaining elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • OptionaldeleteCount: number

      The number of elements to remove.

    Returns yaml.Document.Parsed<ParsedNode>[]

    A copy of the original array with the remaining elements.

  • Returns a string representation of an array.

    Returns string

  • Inserts new elements at the start of an array, and returns the new length of the array.

    Parameters

    Returns number

  • Copies an array, then overwrites the value at the provided index with the given value. If the index is negative, then it replaces from the end of the array.

    Parameters

    • index: number

      The index of the value to overwrite. If the index is negative, then it replaces from the end of the array.

    • value: yaml.Document.Parsed<ParsedNode>

      The value to write into the copied array.

    Returns yaml.Document.Parsed<ParsedNode>[]

    The copied array with the updated value.