Class InMemoryDataItemDBDriver<ItemType, UniquelyIdentifyingFieldName>

createItem

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

  Create a new item in memory.

  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 memory.

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

  List items from memory.

  Parameters

  • config: ListItemsConfig

    List configuration and criteria.

  • OptionalselectedFields: (keyof ItemType)[]

    Optional fields to select from each item.

  Returns Promise<ListItemsResults<ItemType>>

  List results with items and cursor.

readItem

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

  Read an item from memory.

  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>,
      updateConfig?: TypeInfoORMUpdateConfig,
  ): Promise<boolean>

  Update an item in memory.

  Parameters

  • uniqueIdentifier: ItemType[UniquelyIdentifyingFieldName]

    Unique identifier value for the item.

  • updatedItem: Partial<ItemType>

    Partial update payload for the item.

  • OptionalupdateConfig: TypeInfoORMUpdateConfig

  Returns Promise<boolean>

  True when the item was updated.

readItemStronglyConsistent