Interface SyncWritableStore<ItemType, IDType>

A synchronous store that accepts changes to it's contents.

Deprecated

use WritableAsyncStore instead

Type Parameters

Hierarchy

Implemented by

Properties

id idProperty?

Methods

add get getIdentity? getMetadata put query remove

Properties

Readonly id

id: string

ID of the store.

Optional Readonly idProperty

idProperty?: string

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

Methods

add

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

    Parameters

    Returns ItemType

get

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

Optional getIdentity

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

    Parameters

    • item: Partial<ItemType>

      the item

    Returns undefined | IDType

    the ID

getMetadata

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

    Returns Metadata

put

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

    Parameters

    • item: Partial<ItemType>

      item to update/create

    • Optional options: CreateOptions<IDType>

      options to specify the PUT operation

    Returns ItemType

query

remove

  • Delete an item by id.

    Parameters

    • id: IDType

      id of item to delete

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc