Class CollectionEntityAdapter<T>

Class representing a Collection Entity Adapter.

Implements

Type Parameters

Implements

Constructors

constructor

Properties

id refresh setData toEntity toObject

Accessors

data

Constructors

constructor

Properties

Readonlyid

id: string | number

An identifier representing the unique identity of an entity.

refresh

refresh: () => Promise<void>

Refreshes the entity asynchronously.

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

      A Promise that resolves once the entity is refreshed.

Throws

If an error occurs while refreshing the entity.

setData

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

Sets the data for the entity.

Type declaration

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

    • Parameters

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

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

      Returns Promise<void>

      • A promise that resolves when the data is set.

Async

Throws

  • If the entity (with the given ID) is not found in the collection.

toEntity

toEntity: () => Entity<T>

Retrieves the entity with the specified ID from the current collection.

Type declaration

Throws

If the entity is not found in the collection.

toObject

toObject: () => T

Converts the current object to a plain JavaScript object.

Type declaration

    • (): T

    • Returns T

      A plain JavaScript object representing the current entity.

Member Of

[variable name]

Throws

If the entity is not found in the collection.

Accessors

data

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors