Interface AsyncStore<ItemType, IDType>

Readonly id

Optional Readonly idProperty

get

• get(id, options?): Promise<undefined | ItemType>

• Retrieves an item by its identifier.

  Parameters

  • id: IDType

    id of an item in the store.

  • Optional options: GetOptions

    options to specify the result.

  Returns Promise<undefined | ItemType>

Optional getIdentity

• getIdentity(item): undefined | IDType

• Returns an items‘s identity. This must always execute synchronously.

  Parameters

  • item: Partial<ItemType>

    the item.

  Returns undefined | IDType

  the ID

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>

query

• query(query?, options?): AsyncQueryResult<ItemType>

• Queries the store using the provided query.

  Parameters

  • Optional query: ComplexQueryExpression

    a query to execute.

  • Optional options: QueryOptions

    the query options.

  Returns AsyncQueryResult<ItemType>