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

Properties

Accessors

id idProperty

Methods

add get getIdentity getMetadata put query remove

Properties

`Readonly`on

on:
    | undefined
    | {
        <Name extends "changed">(
            eventName: Name,
            callback: EventCallback<StoreEvents<IDType>[Name]>,
        ): EventHandle;
        (
            eventName: "*",
            callback: EventCallback<StoreChangedEvent<IDType>>,
        ): EventHandle;
        (
            eventName: string | string[],
            callback: EventCallback<unknown>,
        ): EventHandle;
    }

Type declaration

undefined
{
    <Name extends "changed">(
        eventName: Name,
        callback: EventCallback<StoreEvents<IDType>[Name]>,
    ): EventHandle;
    (
        eventName: "*",
        callback: EventCallback<StoreChangedEvent<IDType>>,
    ): EventHandle;
    (
        eventName: string | string[],
        callback: EventCallback<unknown>,
    ): EventHandle;
}
- - <Name extends "changed">(
    eventName: Name,
    callback: EventCallback<StoreEvents<IDType>[Name]>,
    ): EventHandle
  - Type Parameters
    - Name extends "changed"
    Parameters
    - eventName: Name
    - callback: EventCallback<StoreEvents<IDType>[Name]>
    Returns EventHandle
  - (
    eventName: "*",
    callback: EventCallback<StoreChangedEvent<IDType>>,
    ): 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
  - (eventName: string | string[], callback: EventCallback<unknown>): 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)

Param: eventName

name of the event

Param: callback

the event handler callback will be invoked when the event has been emitted

Returns

a handle to unregister from the event

Accessors

id

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

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

idProperty

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

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

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 target/aggregate-api-docs/src/main/js/search/store-api/InMemoryStore.ts:204

get

get(id: IDType, options?: GetOptions): Promise<undefined | ItemType>
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<undefined | ItemType>
Implementation of AsyncWritableStore.get
Inherited from AsyncInMemoryStore.get
- Defined in target/aggregate-api-docs/src/main/js/search/store-api/InMemoryStore.ts:184

getIdentity

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

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 target/aggregate-api-docs/src/main/js/search/store-api/InMemoryStore.ts:188

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 target/aggregate-api-docs/src/main/js/search/store-api/InMemoryStore.ts:200

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 target/aggregate-api-docs/src/main/js/search/store-api/InMemoryStore.ts:176

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 target/aggregate-api-docs/src/main/js/search/store-api/InMemoryStore.ts:208

Class AsyncWritableInMemoryStore<ItemType, IDType>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Properties

Accessors

Methods

Properties

Readonlyon

Type declaration

Type Parameters

Parameters

Returns EventHandle

Parameters

Returns EventHandle

Parameters

Returns EventHandle

Param: eventName

Param: callback

Returns

Accessors

id

Returns undefined | string

idProperty

Returns undefined | string

Methods

add

Parameters

Returns Promise<void | ItemType>

get

Parameters

Returns Promise<undefined | ItemType>

getIdentity

Parameters

Returns undefined | IDType

getMetadata

Returns Promise<Metadata>

put

Parameters

Returns Promise<void | ItemType>

query

Parameters

Returns AsyncQueryResult<ItemType>

remove

Parameters

Returns Promise<void>

Settings

On This Page

`Readonly`on