Class SyncWritableInMemoryStore<ItemType, IDType>

Readonlyid

ReadonlyidProperty

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

get

• get(id: IDType): undefined | ItemType

• Retrieves an item by its identifier.

  Parameters

  • id: IDType

    id of an item in the store.

  Returns undefined | ItemType

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

getMetadata

• getMetadata(): Metadata

• Returns any available metadata about the store. This may include attribution, available fields, cache directives, history or version information.

  Returns Metadata

on

• on<Name extends "changed">(
      eventName: Name,
      callback: EventCallback<StoreEvents<IDType>[Name]>,
  ): 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
• on(
      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
• on(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)

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>