ixfx
    Preparing search index...

    Function wrapUnsorted

    • wrapUnsorted<T>(
          unsortedData: T[],
          comparer?: Comparer<T>,
      ): {
          at: (offset: number) => undefined | T;
          indexOf: (sought: T, start?: number, end?: number) => number;
          insert: (
              toInsert: T,
          ) => { indexOf: (sought: T, start?: number, end?: number) => number; insertionIndex: (toInsert: T) => number; insert: (toInsert: T) => ...; remove: (toRemove: T) => ...; at: (offset: number) => T | undefined; readonly length: number; readonly data: T[]; toArray: () => T[]; };
          insertionIndex: (toInsert: T) => number;
          remove: (
              toRemove: T,
          ) => { indexOf: (sought: T, start?: number, end?: number) => number; insertionIndex: (toInsert: T) => number; insert: (toInsert: T) => ...; remove: (toRemove: T) => ...; at: (offset: number) => T | undefined; readonly length: number; readonly data: T[]; toArray: () => T[]; };
          toArray: () => T[];
          get data(): T[];
          get length(): number;
      }

      Returns an immutable wrapper around an array, initially unsorted. Sorts data and passes to wrapSorted.

      Type Parameters

      • T

      Parameters

      • unsortedData: T[]
      • comparer: Comparer<T> = defaultComparer

      Returns {
          at: (offset: number) => undefined | T;
          indexOf: (sought: T, start?: number, end?: number) => number;
          insert: (
              toInsert: T,
          ) => { indexOf: (sought: T, start?: number, end?: number) => number; insertionIndex: (toInsert: T) => number; insert: (toInsert: T) => ...; remove: (toRemove: T) => ...; at: (offset: number) => T | undefined; readonly length: number; readonly data: T[]; toArray: () => T[]; };
          insertionIndex: (toInsert: T) => number;
          remove: (
              toRemove: T,
          ) => { indexOf: (sought: T, start?: number, end?: number) => number; insertionIndex: (toInsert: T) => number; insert: (toInsert: T) => ...; remove: (toRemove: T) => ...; at: (offset: number) => T | undefined; readonly length: number; readonly data: T[]; toArray: () => T[]; };
          toArray: () => T[];
          get data(): T[];
          get length(): number;
      }

      • at: (offset: number) => undefined | T

        Gets item at a specified offset

      • indexOf: (sought: T, start?: number, end?: number) => number

        Returns index of an item, or -1 if not found

      • insert: (
            toInsert: T,
        ) => { indexOf: (sought: T, start?: number, end?: number) => number; insertionIndex: (toInsert: T) => number; insert: (toInsert: T) => ...; remove: (toRemove: T) => ...; at: (offset: number) => T | undefined; readonly length: number; readonly data: T[]; toArray: () => T[]; }

        Inserts an item, returning a new wrapper

      • insertionIndex: (toInsert: T) => number
      • remove: (
            toRemove: T,
        ) => { indexOf: (sought: T, start?: number, end?: number) => number; insertionIndex: (toInsert: T) => number; insert: (toInsert: T) => ...; remove: (toRemove: T) => ...; at: (offset: number) => T | undefined; readonly length: number; readonly data: T[]; toArray: () => T[]; }

        Removes an item, returning a new wrapper

      • toArray: () => T[]

        Returns a copy of data which is safe to modify.

      • getdata():T[]

        Gets underlying data. Be careful not to mutate. Use toArray to get a copy that can be modified.

      • getlength():number

        Gets length

    Settings

    Member Visibility