Class ArrayObjectStore<T>

Type Parameters

T = BaseArrayObjectEntryStore

Hierarchy

ArrayObjectStore (View Summary)
- CrudArrayObjectStore

Index

Constructors

Accessors

_data dataReducer length EntryStore

Methods

[iterator] clearEntries createEntry deleteEntry duplicateEntry findEntry getEntry set subscribe toJSON updateSubscribers

Constructors

constructor

new ArrayObjectStore<T = BaseArrayObjectEntryStore>(
params?: ArrayObjectStoreParams,
): ArrayObjectStore<T>
Type Parameters
- T = BaseArrayObjectEntryStore
Parameters
- Optionalparams: ArrayObjectStoreParams
Returns ArrayObjectStore<T>

Accessors

`Protected`_data

get _data(): T[]
Protected
Returns T[]
The internal data array tracked allowing child classes direct access.

dataReducer

get dataReducer(): DynArrayReducer<T>
Returns DynArrayReducer<T>
The data reducer.

length

get length(): number
Returns number
The length of all data.

`Static`EntryStore

get EntryStore(): ObjectEntryStore
Returns ObjectEntryStore
The default object entry store constructor.

Methods

[iterator]

"[iterator]"(): Generator<T, void, unknown>
Provide an iterator for public access to entry stores.

Returns Generator<T, void, unknown>
Yields

clearEntries

clearEntries(): void
Removes all child store entries.

Returns void

createEntry

createEntry(entryData?: object): T
Creates a new store from given data.
Parameters
- OptionalentryData: object
Returns T
The store

deleteEntry

deleteEntry(id: string): boolean
Deletes a given entry store by ID from this world setting array store instance.
Parameters
- id: string
  ID of entry to delete.
Returns boolean
Delete operation successful.

duplicateEntry

duplicateEntry(id: string): any
Duplicates an entry store by the given ID.
Parameters
- id: string
  UUIDv4 string.
Returns any
Instance of StoreClass.

findEntry

findEntry(predicate: (arg0: T) => void | T): void | T
Find an entry in the backing child store array.
Parameters
- predicate: (arg0: T) => void | T
  A predicate function
Returns void | T
Found entry in array or undefined.

getEntry

getEntry(id: string): void | T
Finds an entry store instance by 'id' / UUIDv4.
Parameters
- id: string
  A UUIDv4 string.
Returns void | T
Entry store instance.

set

set(updateList: T[]): void
Sets the children store data by 'id', adds new entry store instances, or removes entries that are no longer in the update list.
Parameters
- updateList: T[]
Returns void

subscribe

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

toJSON

toJSON(): T[]
Returns T[]

updateSubscribers

updateSubscribers(update?: ArrayObjectUpdateData): void
Updates subscribers.
Parameters
- Optionalupdate: ArrayObjectUpdateData
Returns void