API Documentation
    Preparing search index...

    Class AsyncInMemoryStore<ItemType, IDType>

    A readonly asynchronous store.

    Type Parameters

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

    Hierarchy (View Summary)

    Implements

    Index

    Accessors

    id idProperty

    Methods

    get getIdentity getMetadata query

    Accessors

    • get id(): string | undefined

      ID of the store.

      Returns string | undefined

    • get idProperty(): string | undefined

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

      Returns string | undefined

    Methods

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

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

      Parameters

      Returns IDType | undefined

      the ID

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

      Returns Promise<Metadata>

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods