map.apps Bundle APIs 4.20.0
    Preparing search index...

    Interface AsyncWritableStore<ItemType, IDType>

    An asynchronous store that accepts changes to it's contents.

    interface AsyncWritableStore<
        ItemType extends IndexableThing = IndexableThing,
        IDType extends AllowedIdTypes = AllowedIdTypes,
    > {
        add(
            item: Partial<ItemType>,
            options?: CreateOptions<IDType>,
        ): Promise<void | ItemType>;
        get(id: IDType, options?: GetOptions): Promise<undefined | ItemType>;
        getIdentity(item: Partial<ItemType>): undefined | IDType;
        getMetadata(): Promise<Metadata>;
        id: undefined | string;
        idProperty?: string;
        put(
            item: Partial<ItemType>,
            options?: CreateOptions<IDType>,
        ): Promise<void | ItemType>;
        query(
            query?: ComplexQueryExpression,
            options?: QueryOptions,
        ): AsyncQueryResult<ItemType>;
        remove(id: IDType): Promise<void>;
    }

    Type Parameters

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    id idProperty?

    Methods

    add get getIdentity? getMetadata put query remove

    Properties

    id: undefined | string

    ID of the store.

    idProperty?: string

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

    Methods

    • Create a new item. Throws an error, if the item already exists. The 'overwrite' option is assumed to be false).

      Parameters

      Returns Promise<void | 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>

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

      Parameters

      Returns undefined | IDType

      the ID

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

      Returns Promise<Metadata>

    • Saves the given item. Depending on the specified options, a new item is created or a given item is updated.

      Parameters

      Returns Promise<void | ItemType>

    • Delete an item by id.

      Parameters

      • id: IDType

        id of item to delete

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods