Class ObjectEntryStore<T>`Abstract`

Provides a base implementation for store entries in ArrayObjectStore.

In particular providing the required getting / accessor for the 'id' property.

Type Parameters

T extends BaseArrayObject = BaseArrayObject

Implements

BaseObjectEntryStore<T>

Index

Constructors

Accessors

Methods

_updateSubscribers set subscribe toJSON duplicate

Constructors

constructor

new ObjectEntryStore<T extends BaseArrayObject = BaseArrayObject>(
data: T,
): ObjectEntryStore<T>
Type Parameters
- T extends BaseArrayObject = BaseArrayObject
Parameters
- data: T
Returns ObjectEntryStore<T>

Accessors

`Protected`_data

get _data(): T
Returns T
The object data tracked by this store.

id

get id(): string
Returns string
The ID attribute in object data tracked by this store.

Implementation of ArrayObjectStore.Data.BaseObjectEntryStore.id

Methods

`Protected`_updateSubscribers

_updateSubscribers(): void
Update subscribers of this store. Useful for child implementations.

Returns void

`Abstract`set

set(data: T): void
To be implemented by child implementations as required by the MinimalWritable contract. You must manually invoke ObjectEntryStore._updateSubscribers to notify subscribers.
Parameters
- data: T
  Data to set to store.
Returns void
Implementation of BaseObjectEntryStore.set

subscribe(handler: Subscriber<T>): Unsubscriber
Parameters
- handler: Subscriber<T>
  Callback function that is invoked on update / changes.
Returns Unsubscriber
Unsubscribe function.

Implementation of BaseObjectEntryStore.subscribe

toJSON

toJSON(): T
Returns T
A JSON data object for the backing data. The default implementation directly returns the backing private data object. You may override this method to clone the data via ObjectEntryStore._data.

Implementation of BaseObjectEntryStore.toJSON

`Static`duplicate

duplicate(data: object, arrayStore: ArrayObjectStore<any>): void
Invoked by ArrayObjectStore to provide custom duplication. Override this static method in your entry store.
Parameters
- data: object
  A copy of local data w/ new ID already set.
- arrayStore: ArrayObjectStore<any>
  The source ArrayObjectStore instance.
Returns void