Interface IEntityAdapter<T>

Represents an interface for an entity adapter.

interface IEntityAdapter<T extends IEntity = any> {
    data: T;
    id: string | number;
    refresh(): void;
    setData(data: Partial<T> | (prevData: T) => Partial<T>): void;
    toObject(): T;
}

Type Parameters

  • T extends IEntity = any

    The type of the entity.

Implemented by

Properties

data id

Methods

refresh setData toObject

Properties

data

data: T

Represents a variable of type T.

Typeparam

T - The type of data stored in the variable.

id

id: string | number

An identifier representing the unique identity of an entity.

Methods

refresh

  • refresh(): void

    Refreshes the view or data associated with the current state. This method internally handles the logic to update the view or fetch the latest data based on the current state of the application. Note that this method does not return any value.

    Returns void

    Function

    Name

    refresh

setData

  • setData(data: Partial<T> | (prevData: T) => Partial<T>): void

    Sets the data for the given object.

    Parameters

    • data: Partial<T> | (prevData: T) => Partial<T>

      The data to be set. It can be either a partial object of type T or a function that takes the previous data of type T as input and returns a partial object of type T.

    Returns void

toObject

  • toObject(): T

    Converts the current object to its corresponding type T.

    Returns T

    The converted object of type T.

Settings

Member Visibility

On This Page

Properties
Methods