Motif API
    Preparing search index...

    Interface ComparableList<T, U>

    interface ComparableList<out T extends U, in U = T> {
        capacity: number;
        capacityIncSize: number;
        count: number;
        items: readonly T[];
        lastIndex: number;
        add(value: T): number;
        addRange(values: readonly T[]): void;
        addSubRange(
            values: readonly T[],
            subRangeStartIndex: number,
            subRangeCount: number,
        ): void;
        addUndefinedRange(undefinedValueCount: number): void;
        binaryFindAny(compareToFn: CompareItemFn<T>): BinaryFind.Result;
        binaryFindEarliest(compareToFn: CompareItemFn<T>): BinaryFind.Result;
        binaryFindLatest(compareToFn: CompareItemFn<T>): BinaryFind.Result;
        binarySearchAny(
            item: T,
            compareCallback?: ReadonlyComparableList.CompareCallback<T>,
        ): BinaryFind.Result;
        binarySearchEarliest(
            item: T,
            compareCallback?: ReadonlyComparableList.CompareCallback<T>,
        ): BinaryFind.Result;
        binarySearchLatest(
            item: T,
            compareCallback?: ReadonlyComparableList.CompareCallback<T>,
        ): BinaryFind.Result;
        clear(): void;
        clone(): ComparableList<T, U>;
        compareItems(left: T, right: T): ComparisonResult;
        contains(value: T): boolean;
        exchange(index1: number, index2: number): void;
        extract(value: T): T;
        find(predicate: (value: T, index: number) => boolean): T;
        findIndex(predicate: (value: T, index: number) => boolean): number;
        first(): T;
        getAt(index: number): T;
        has(predicate: (value: T, index: number) => boolean): boolean;
        indexOf(value: T): number;
        insert(index: number, value: T): void;
        insertRange(index: number, values: T[]): void;
        insertSubRange(
            index: number,
            values: readonly T[],
            subRangeStartIndex: number,
            subRangeCount: number,
        ): void;
        last(): T;
        move(curIndex: number, newIndex: number): void;
        moveRange(fromIndex: number, toIndex: number, count: number): void;
        rangeToArray(index: number, count: number): T[];
        remove(value: T): void;
        removeAtIndex(index: number): void;
        removeAtIndices(
            removeIndices: number[],
            beforeRemoveRangeCallBack?: BeforeRemoveRangeCallBack,
        ): void;
        removeItems(
            items: readonly T[],
            beforeRemoveRangeCallBack?: BeforeRemoveRangeCallBack,
        ): void;
        removeRange(index: number, deleteCount: number): void;
        setAt(index: number, value: T): void;
        setGrowthCapacity(growth: number): void;
        setMinimumCapacity(value: number): void;
        shift(): T;
        sort(compareCallback?: ComparableList.CompareCallback<T>): void;
        toArray(): readonly T[];
        trimExcess(): void;
    }

    Type Parameters

    • out T extends U
    • in U = T

    Hierarchy (View Summary)

    Index

    Properties

    capacity capacityIncSize count items lastIndex

    Methods

    add addRange addSubRange addUndefinedRange binaryFindAny binaryFindEarliest binaryFindLatest binarySearchAny binarySearchEarliest binarySearchLatest clear clone compareItems contains exchange extract find findIndex first getAt has indexOf insert insertRange insertSubRange last move moveRange rangeToArray remove removeAtIndex removeAtIndices removeItems removeRange setAt setGrowthCapacity setMinimumCapacity shift sort toArray trimExcess

    Properties

    capacity: number
    capacityIncSize: number
    count: number
    items: readonly T[]
    lastIndex: number

    Methods

    • Parameters

      • value: T

      Returns number

    • Parameters

      • values: readonly T[]

      Returns void

    • Parameters

      • values: readonly T[]
      • subRangeStartIndex: number
      • subRangeCount: number

      Returns void

    • Parameters

      • undefinedValueCount: number

      Returns void

    • Returns void

    • Parameters

      • index1: number
      • index2: number

      Returns void

    • Parameters

      • value: T

      Returns T

    • Parameters

      • predicate: (value: T, index: number) => boolean

      Returns T

    • Parameters

      • predicate: (value: T, index: number) => boolean

      Returns number

    • Parameters

      • predicate: (value: T, index: number) => boolean

      Returns boolean

    • Parameters

      • index: number
      • value: T

      Returns void

    • Parameters

      • index: number
      • values: T[]

      Returns void

    • Parameters

      • index: number
      • values: readonly T[]
      • subRangeStartIndex: number
      • subRangeCount: number

      Returns void

    • Parameters

      • curIndex: number
      • newIndex: number

      Returns void

    • Parameters

      • fromIndex: number
      • toIndex: number
      • count: number

      Returns void

    • Parameters

      • value: T

      Returns void

    • Parameters

      • index: number

      Returns void

    • Parameters

      • index: number
      • deleteCount: number

      Returns void

    • Parameters

      • index: number
      • value: T

      Returns void

    • Parameters

      • growth: number

      Returns void

    • Parameters

      • value: number

      Returns void

    • Returns T

    • Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods