Interface ICollectionAdapter<T>

An interface representing a collection adapter.

interface ICollectionAdapter<T extends IEntity = any> {
    clear(): void;
    filter(
        predicate: (value: IEntityAdapter<T>, idx: number) => boolean,
    ): IEntityAdapter<T>[];
    find(
        predicate: (value: IEntityAdapter<T>, idx: number) => boolean,
    ): undefined | IEntityAdapter<T>;
    findById(id: string | number): IEntityAdapter<T>;
    forEach(callbackfn: (value: IEntityAdapter<T>, idx: number) => void): void;
    ids: (string | number)[];
    isEmpty: boolean;
    items: IEntityAdapter<T>[];
    lastIdx: number;
    map<V = any>(callbackfn: (value: IEntityAdapter<T>, idx: number) => V): V[];
    push(...items: T[] | T[][]): void;
    refresh(): void;
    remove(item: IEntity): void;
    removeAll(): void;
    removeById(id: string | number): void;
    setData(items: T[]): void;
    some(
        predicate: (value: IEntityAdapter<T>, idx: number) => boolean,
    ): boolean;
    toArray(): T[];
    upsert(...items: T[] | T[][]): void;
}

Type Parameters

  • T extends IEntity = any

    The type of entities in the collection.

Implemented by

Properties

ids isEmpty items lastIdx

Methods

clear filter find findById forEach map push refresh remove removeAll removeById setData some toArray upsert

Properties

ids

ids: (string | number)[]

Represents an array of entity IDs.

isEmpty

isEmpty: boolean

Checks if a value is empty or not.

Param: value

The value to check if it is empty.

Returns

  • True if the value is empty, otherwise false.

items

items: IEntityAdapter<T>[]

Represents an array of IEntityAdapter objects.

Template: T

The type of entities that the adapters handle.

lastIdx

lastIdx: number

Represents the last index of an array or string.

Methods

clear

  • clear(): void

    Clears the data of the object.

    Returns void

filter

  • filter(
        predicate: (value: IEntityAdapter<T>, idx: number) => boolean,
    ): IEntityAdapter<T>[]

    Filters an array of IEntityAdapter objects based on a provided predicate function.

    Parameters

    • predicate: (value: IEntityAdapter<T>, idx: number) => boolean

      The predicate function used to test each IEntityAdapter object. The function should accept two arguments: - value: The current IEntityAdapter object being processed. - idx: The index of the current IEntityAdapter object being processed. The predicate function should return a boolean value indicating whether to include the entity in the filtered array.

    Returns IEntityAdapter<T>[]

    • An array of IEntityAdapter objects that satisfy the provided predicate.

find

  • find(
        predicate: (value: IEntityAdapter<T>, idx: number) => boolean,
    ): undefined | IEntityAdapter<T>

    Finds the first element in the IEntityAdapter array that satisfies the provided testing function.

    Parameters

    • predicate: (value: IEntityAdapter<T>, idx: number) => boolean

      The testing function that determines whether the element is found or not. It should accept two parameters: value (IEntityAdapter) and idx (number).

    Returns undefined | IEntityAdapter<T>

    • The first element that satisfies the testing function, or undefined if no such element is found.

findById

  • findById(id: string | number): IEntityAdapter<T>

    Finds an entity by its ID.

    Parameters

    • id: string | number

      The ID of the entity to find.

    Returns IEntityAdapter<T>

    • The entity adapter containing the found entity, if any.

forEach

  • forEach(callbackfn: (value: IEntityAdapter<T>, idx: number) => void): void

    Executes a provided function once for each entity in the adapter.

    Parameters

    • callbackfn: (value: IEntityAdapter<T>, idx: number) => void

      The function to execute for each entity. It accepts two arguments: the current entity value and the index of the entity in the adapter.

    Returns void

map

  • map<V = any>(callbackfn: (value: IEntityAdapter<T>, idx: number) => V): V[]

    Applies a mapping function to each value of an entity adapter and returns an array of the mapped values.

    Type Parameters

    • V = any

      The type of values in the resulting array.

    Parameters

    • callbackfn: (value: IEntityAdapter<T>, idx: number) => V

      The mapping function to be applied to each value. It takes two arguments: the value itself and its index in the entity adapter.

    Returns V[]

    An array containing the mapped values.

push

  • push(...items: T[] | T[][]): void

    Pushes one or more items onto the end of the array.

    Parameters

    • ...items: T[] | T[][]

      The items to push onto the array.

    Returns void

refresh

  • refresh(): void

    Refreshes the content of the page.

    Returns void

    This method has no return value.

remove

  • remove(item: IEntity): void

    Removes the specified item from the collection.

    Parameters

    • item: IEntity

      The item to be removed from the collection.

    Returns void

removeAll

  • removeAll(): void

    Removes all elements from the collection.

    Returns void

removeById

  • removeById(id: string | number): void

    Removes an entity from the collection by its id.

    Parameters

    • id: string | number

      The id of the entity to be removed.

    Returns void

setData

  • setData(items: T[]): void

    Sets the data for the items.

    Parameters

    • items: T[]

      An array of items to be set as the data.

    Returns void

some

  • some(predicate: (value: IEntityAdapter<T>, idx: number) => boolean): boolean

    Checks if any of the elements in the array satisfies the provided predicate.

    Parameters

    • predicate: (value: IEntityAdapter<T>, idx: number) => boolean

      The predicate function to be executed for each element in the array. It takes two parameters: - value: The current element being processed. - idx: The index of the current element being processed. The function should return a boolean value indicating whether the element satisfies the condition.

    Returns boolean

    • Returns true if at least one element satisfies the predicate, otherwise returns false.

toArray

  • toArray(): T[]

    Converts the collection into an array.

    Returns T[]

    An array containing the elements of the collection.

upsert

  • upsert(...items: T[] | T[][]): void

    Upserts the given items into the database.

    Parameters

    • ...items: T[] | T[][]

      The items to be upserted. Can be a single array or an array of arrays.

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods