Type Alias DataItemDBDriver<ItemType, UniquelyIdentifyingFieldName>

The API for a database driver.

type DataItemDBDriver<
    ItemType extends TypeInfoDataItem,
    UniquelyIdentifyingFieldName extends keyof ItemType,
> = {
    createItem: (
        newItem: Partial<Omit<ItemType, UniquelyIdentifyingFieldName>>,
    ) => Promise<ItemType[UniquelyIdentifyingFieldName]>;
    deleteItem: (
        uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName],
    ) => Promise<boolean>;
    listItems: (
        config: ListItemsConfig,
        selectedFields?: (keyof ItemType)[],
    ) => Promise<ListItemsResults<Partial<ItemType>>>;
    readItem: (
        uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName],
        selectedFields?: (keyof ItemType)[],
    ) => Promise<Partial<ItemType>>;
    updateItem: (
        uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName],
        updatedItem: Partial<ItemType>,
    ) => Promise<boolean>;
}

Type Parameters

ItemType extends TypeInfoDataItem
UniquelyIdentifyingFieldName extends keyof ItemType

Implemented by

Index

Properties

createItem deleteItem listItems readItem updateItem

Properties

createItem

createItem: (
newItem: Partial<Omit<ItemType, UniquelyIdentifyingFieldName>>,
) => Promise<ItemType[UniquelyIdentifyingFieldName]>

Create a new item in the data store.

Type Declaration

- (
  newItem: Partial<Omit<ItemType, UniquelyIdentifyingFieldName>>,
  ): Promise<ItemType[UniquelyIdentifyingFieldName]>
- Parameters
  - newItem: Partial<Omit<ItemType, UniquelyIdentifyingFieldName>>
    New item payload without the identifying field.
  Returns Promise<ItemType[UniquelyIdentifyingFieldName]>
  Generated identifier for the created item.

deleteItem

deleteItem: (
uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName],
) => Promise<boolean>

Delete an item from the data store.

Type Declaration

- (uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName]): Promise<boolean>
- Parameters
  - uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName]
    Unique identifier value for the item.
  Returns Promise<boolean>
  True when the item was deleted.

listItems

listItems: (
config: ListItemsConfig,
selectedFields?: (keyof ItemType)[],
) => Promise<ListItemsResults<Partial<ItemType>>>

List items from the data store.

Type Declaration

- (
  config: ListItemsConfig,
  selectedFields?: (keyof ItemType)[],
  ): Promise<ListItemsResults<Partial<ItemType>>>
- Parameters
  - config: ListItemsConfig
    List configuration and criteria.
  - OptionalselectedFields: (keyof ItemType)[]
    Optional fields to select from each item.
  Returns Promise<ListItemsResults<Partial<ItemType>>>
  List results with items and cursor.

readItem

readItem: (
uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName],
selectedFields?: (keyof ItemType)[],
) => Promise<Partial<ItemType>>

Read an item from the data store.

Type Declaration

- (
  uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName],
  selectedFields?: (keyof ItemType)[],
  ): Promise<Partial<ItemType>>
- Parameters
  - uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName]
    Unique identifier value for the item.
  - OptionalselectedFields: (keyof ItemType)[]
    Optional fields to select from the item.
  Returns Promise<Partial<ItemType>>
  Item payload (partial when selected fields are used).

updateItem

updateItem: (
uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName],
updatedItem: Partial<ItemType>,
) => Promise<boolean>

Update an item in the data store.

Type Declaration

- (
  uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName],
  updatedItem: Partial<ItemType>,
  ): Promise<boolean>
- Parameters
  - uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName]
    Unique identifier value for the item.
  - updatedItem: Partial<ItemType>
    Partial update payload for the item.
  Returns Promise<boolean>
  True when the item was updated.