Class AsyncWritableInMemoryStore<ItemType, IDType>

A writeable asynchronous store.

Type Parameters

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

Hierarchy (View Summary)

AsyncInMemoryStore<ItemType, IDType>
- AsyncWritableInMemoryStore

Implements

AsyncWritableStore<ItemType, IDType>

Index

Accessors

Methods

add get getIdentity getMetadata put query remove

Accessors

id

get id(): string | undefined
ID of the store.

Returns string | undefined
Implementation of AsyncWritableStore.id
Inherited from AsyncInMemoryStore.id
- Defined in src/main/js/search/store-api/InMemoryStore.ts:167

idProperty

get idProperty(): string | undefined
Name of the property used as ID. If not provided, the 'getIdentity' method must be declared.

Returns string | undefined
Implementation of AsyncWritableStore.idProperty
Inherited from AsyncInMemoryStore.idProperty
- Defined in src/main/js/search/store-api/InMemoryStore.ts:171

Methods

add

add(
item: Partial<ItemType>,
options?: CreateOptions<IDType>,
): Promise<void | 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 Promise<void | ItemType>
Implementation of AsyncWritableStore.add
- Defined in src/main/js/search/store-api/InMemoryStore.ts:207

get

get(id: IDType, options?: GetOptions): Promise<ItemType | undefined>
Retrieves an item by its identifier.
Parameters
- id: IDType
  id of an item in the store.
- Optionaloptions: GetOptions
  options to specify the result.
Returns Promise<ItemType | undefined>
Implementation of AsyncWritableStore.get
Inherited from AsyncInMemoryStore.get
- Defined in src/main/js/search/store-api/InMemoryStore.ts:187

getIdentity

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

getMetadata

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

Returns Promise<Metadata>
Implementation of AsyncWritableStore.getMetadata
Inherited from AsyncInMemoryStore.getMetadata
- Defined in src/main/js/search/store-api/InMemoryStore.ts:191

put

put(
item: Partial<ItemType>,
options?: CreateOptions<IDType>,
): Promise<void | 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 Promise<void | ItemType>
Implementation of AsyncWritableStore.put
- Defined in src/main/js/search/store-api/InMemoryStore.ts:203

query

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

remove

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