binstree/types/binstree.d.ts

Binary search trees for ES6

declare namespace node {
  type Degree = 0 | 1 | 2;

  export interface Constructor {
    new <T = any>(key: number, value: T): Instance<T>;
  }

  export interface Instance<T> {
    value: T;
    left: Instance<T> | null;
    right: Instance<T> | null;
    readonly key: number;
    readonly children: Instance<T>[];
    readonly degree: Degree;
    height(): number;
    isFull(): boolean;
    isInternal(): boolean;
    isLeaf(): boolean;
    isLeftPartial(): boolean;
    isPartial(): boolean;
    isRightPartial(): boolean;
    toPair(): [number, T];
  }
}

declare namespace tree {
  type UnaryCallback<T> = (x: T) => void;

  interface Node<T> extends node.Instance<T> {}

  export interface Constructor {
    new <T = any>(): Instance<T>;
  }

  export interface Instance<T> {
    readonly root: Node<T> | null;
    clear(): this;
    fullNodes(): Node<T>[];
    height(): number;
    includes(key: number): boolean;
    inOrder(fn: UnaryCallback<Node<T>>): this;
    insert(key: number, value: T): this;
    internalNodes(): Node<T>[];
    isBalanced(): boolean;
    isComplete(): boolean;
    isEmpty(): boolean;
    isFull(): boolean;
    isPerfect(): boolean;
    leafNodes(): Node<T>[];
    levelOrder(fn: UnaryCallback<Node<T>>): this;
    max(): Node<T> | null;
    min(): Node<T> | null;
    outOrder(fn: UnaryCallback<Node<T>>): this;
    partialNodes(): Node<T>[];
    postOrder(fn: UnaryCallback<Node<T>>): this;
    preOrder(fn: UnaryCallback<Node<T>>): this;
    remove(key: number): this;
    search(key: number): Node<T> | null;
    size(): number;
    toArray(): Node<T>[];
    toPairs(): [number, T][];
  }
}

declare namespace binstree {
  export interface Node<T = any> extends node.Instance<T> {}
  export interface Tree<T = any> extends tree.Instance<T> {}
}

declare const binstree: {
  Node: node.Constructor;
  Tree: tree.Constructor;
};

export = binstree;