Class SyncInMemoryStore<ItemType, IDType>

A read only synchronous store.

Type Parameters

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

Hierarchy (view full)

Implements

Properties

id idProperty

Methods

emit get getIdentity getMetadata on query

Properties

Readonlyid

id: string

ID of the store.

ReadonlyidProperty

idProperty: string

Name of the property used as ID. If not provided, the 'getIdentity' method must be declared.

Methods

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

get

  • get(id): undefined | ItemType

  • Retrieves an item by its identifier.

    Parameters

    • id: IDType

      id of an item in the store.

    Returns undefined | ItemType

getIdentity

  • getIdentity(item): IDType

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

    Parameters

    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>(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

  • 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

  • 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)

query

Settings

Member Visibility

On This Page

Properties
Methods