Class SyncWritableInMemoryStore<ItemType, IDType>

A writable synchronous store.

Type Parameters

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

Hierarchy (view full)

SyncInMemoryStore<ItemType, IDType>
- SyncWritableInMemoryStore

Implements

SyncWritableStore<ItemType, IDType>

Index

Properties

id idProperty

Methods

add emit get getIdentity getMetadata on put query remove

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

add

add(item, options?): ItemType
Create a new item. Throws an error, if the item already exists. The 'overwrite' option is assumed to be false).
Parameters
- item: Partial<ItemType>
- Optionaloptions: CreateOptions<IDType>
Returns ItemType
Implementation of SyncWritableStore.add
- Defined in src/main/js/search/store-api/InMemoryStore.ts:132

emit

emit<Name>(eventName, ...value): 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.
- Rest...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 SyncInMemoryStore.emit
- Defined in src/main/js/apprt/apprt-core/Events.ts:106

get

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

getIdentity

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

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 SyncWritableStore.getMetadata
Inherited from SyncInMemoryStore.getMetadata
- Defined in src/main/js/search/store-api/InMemoryStore.ts:94

on

on<Name>(eventName, callback): EventHandle
Register event listener for specific events.
Type Parameters
- Name extends "changed"
Parameters
- eventName: Name
  name of the event
- callback: EventCallback<StoreEvents<IDType>[Name]>
  the event handler callback will be invoked when the event has been emitted
Returns EventHandle
a handle to unregister from the event
Implementation of SyncWritableStore.on
Inherited from SyncInMemoryStore.on
- Defined in src/main/js/apprt/apprt-core/Events.ts:76
on(eventName, callback): EventHandle
Register event listener for any event.
Parameters
- eventName: "*"
  must be "*" for this overload
- callback: EventCallback<StoreChangedEvent<IDType>>
  the event handler callback will be invoked when any event has been emitted
Returns EventHandle
a handle to unregister from the events
Implementation of SyncWritableStore.on
Inherited from SyncInMemoryStore.on
- Defined in src/main/js/apprt/apprt-core/Events.ts:85
on(eventName, callback): EventHandle
Register event listener for the events listed in eventName. Comma separated event names are possible, for example "eventA,eventB".
Parameters
- eventName: string | string[]
  the event name or list of names
- callback: EventCallback<unknown>
  the event handler callback
Returns EventHandle
a handle to unregister from the event(s)
Implementation of SyncWritableStore.on
Inherited from SyncInMemoryStore.on
- Defined in src/main/js/apprt/apprt-core/Events.ts:95

put

put(item, options?): ItemType
Saves the given item. Depending on the specified options, a new item is created or a given item is updated.
Parameters
- item: Partial<ItemType>
  item to update/create
- Optionaloptions: CreateOptions<IDType>
  options to specify the PUT operation
Returns ItemType
Implementation of SyncWritableStore.put
- Defined in src/main/js/search/store-api/InMemoryStore.ts:106

query

query(query?, options?): 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 SyncWritableStore.query
Inherited from SyncInMemoryStore.query
- Defined in src/main/js/search/store-api/InMemoryStore.ts:85

remove

remove(id): void
Delete an item by id.
Parameters
- id: IDType
  id of item to delete
Returns void
Implementation of SyncWritableStore.remove
- Defined in src/main/js/search/store-api/InMemoryStore.ts:137

Class SyncWritableInMemoryStore<ItemType, IDType>

Type Parameters

Hierarchy (view full)

Implements

Index

Properties

Methods

Properties

Readonlyid

ReadonlyidProperty

Methods

add

Parameters

Returns ItemType

emit

Type Parameters

Parameters

Returns void

get

Parameters

Returns undefined | ItemType

getIdentity

Parameters

Returns IDType

getMetadata

Returns Metadata

on

Type Parameters

Parameters

Returns EventHandle

Parameters

Returns EventHandle

Parameters

Returns EventHandle

put

Parameters

Returns ItemType

query

Parameters

Returns ResultItems<ItemType>

remove

Parameters

Returns void

Settings

On This Page

`Readonly`id

`Readonly`idProperty