collections.api.md

API Report File for "@lumino/collections"

Do not edit this file. It is a report generated by API Extractor.

import { IRetroable } from '@lumino/algorithm';

// @public
export class LinkedList<T> implements Iterable<T>, IRetroable<T> {
    [Symbol.iterator](): IterableIterator<T>;
    addFirst(value: T): LinkedList.INode<T>;
    addLast(value: T): LinkedList.INode<T>;
    assign(values: Iterable<T>): void;
    clear(): void;
    get first(): T | undefined;
    get firstNode(): LinkedList.INode<T> | null;
    insertAfter(value: T, ref: LinkedList.INode<T> | null): LinkedList.INode<T>;
    insertBefore(value: T, ref: LinkedList.INode<T> | null): LinkedList.INode<T>;
    get isEmpty(): boolean;
    get last(): T | undefined;
    get lastNode(): LinkedList.INode<T> | null;
    get length(): number;
    nodes(): IterableIterator<LinkedList.INode<T>>;
    pop(): T | undefined;
    push(value: T): void;
    removeFirst(): T | undefined;
    removeLast(): T | undefined;
    removeNode(node: LinkedList.INode<T>): void;
    retro(): IterableIterator<T>;
    retroNodes(): IterableIterator<LinkedList.INode<T>>;
    shift(value: T): void;
    get size(): number;
    unshift(): T | undefined;
}

// @public
export namespace LinkedList {
    export function from<T>(values: Iterable<T>): LinkedList<T>;
    export interface INode<T> {
        readonly list: LinkedList<T> | null;
        readonly next: INode<T> | null;
        readonly prev: INode<T> | null;
        readonly value: T;
    }
}