Class SyncInMemoryStore<ItemType, IDType>

A read only synchronous store.

Type Parameters

ItemType extends Record<string, any>
IDType extends string | number

Hierarchy (View Summary)

Evented<StoreEvents<IDType>>
- SyncInMemoryStore
  - SyncWritableInMemoryStore

Implements

SyncStore<ItemType, IDType>

Index

Properties

Methods

emit get getIdentity getMetadata query

Properties

`Readonly`id

id: string

ID of the store.

`Readonly`idProperty

idProperty: string

Name of the property used as ID. If not provided, the 'getIdentity' method must be declared.

Methods

emit

emit<Name extends "changed">(
eventName: Name,
...value: Params<StoreEvents<IDType>[Name]>,
): void
Emits an event. All associated event listeners registered for the given event name will be invoked asynchronously.
Type Parameters
- Name extends "changed"
Parameters
- eventName: Name
  The name of the event.
- ...value: Params<StoreEvents<IDType>[Name]>
  The event value. Passed to all event listeners. Note: no value can be passed if the event type is void.
Returns void
Inherited from Evented.emit
- Defined in src/main/js/apprt/apprt-core/Events.ts:81

get

get(id: IDType): ItemType | undefined
Retrieves an item by its identifier.
Parameters
- id: IDType
  id of an item in the store.
Returns ItemType | undefined
Implementation of SyncStore.get
- Defined in src/main/js/search/store-api/InMemoryStore.ts:82

getIdentity

getIdentity(item: Partial<ItemType>): IDType
Returns an items‘s identity. This must always execute synchronously.
Parameters
- item: Partial<ItemType>
  the item
Returns IDType
the ID
Implementation of SyncStore.getIdentity
- Defined in src/main/js/search/store-api/InMemoryStore.ts:78

getMetadata

getMetadata(): Metadata
Returns any available metadata about the store. This may include attribution, available fields, cache directives, history or version information.

Returns Metadata
Implementation of SyncStore.getMetadata
- Defined in src/main/js/search/store-api/InMemoryStore.ts:95

query

query(
query?: ComplexQueryExpression,
options?: QueryOptions,
): ResultItems<ItemType>
Queries the store using the provided query.
Parameters
- Optionalquery: ComplexQueryExpression
  a query to execute.
- Optionaloptions: QueryOptions
  the query options.
Returns ResultItems<ItemType>
Implementation of SyncStore.query
- Defined in src/main/js/search/store-api/InMemoryStore.ts:86