Type alias DataItemDBDriver<ItemType, UniquelyIdentifyingFieldName>

Type declaration

• createItem: ((newItem) => Promise<ItemType[UniquelyIdentifyingFieldName]>)

  • • (newItem): Promise<ItemType[UniquelyIdentifyingFieldName]>

    • Parameters

      • newItem: Partial<Omit<ItemType, UniquelyIdentifyingFieldName>>

      Returns Promise<ItemType[UniquelyIdentifyingFieldName]>

• deleteItem: ((uniqueIdentifier) => Promise<boolean>)

  • • (uniqueIdentifier): Promise<boolean>

    • Parameters

      • uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName]

      Returns Promise<boolean>

• listItems: ((config, selectedFields?) => Promise<ListItemsResults<Partial<ItemType>>>)

  • • (config, selectedFields?): Promise<ListItemsResults<Partial<ItemType>>>

    • Parameters

      • config: ListItemsConfig
      • Optional selectedFields: (keyof ItemType)[]

      Returns Promise<ListItemsResults<Partial<ItemType>>>

• readItem: ((uniqueIdentifier, selectedFields?) => Promise<Partial<ItemType>>)

  • • (uniqueIdentifier, selectedFields?): Promise<Partial<ItemType>>

    • Parameters

      • uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName]
      • Optional selectedFields: (keyof ItemType)[]

      Returns Promise<Partial<ItemType>>

• updateItem: ((uniqueIdentifier, updatedItem) => Promise<boolean>)

  • • (uniqueIdentifier, updatedItem): Promise<boolean>

    • Parameters

      • uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName]
      • updatedItem: Partial<ItemType>

      Returns Promise<boolean>