Class InMemoryFileItemDBDriver

In-memory file driver backed by local state.

Implements

DataItemDBDriver<BaseFileItem, "id">

Index

Methods

createItem deleteItem listItems readItem updateItem

Properties

Methods

createItem

createItem(item: Partial<Omit<BaseFileItem, "id">>): Promise<string>
Create a new file item in memory.
Parameters
- item: Partial<Omit<BaseFileItem, "id">>
  New file item payload without the id field.
Returns Promise<string>
Generated file id.
Implementation of DataItemDBDriver.createItem
- Defined in api/ORM/drivers/InMemoryFileItemDBDriver.ts:129

deleteItem

deleteItem(id: string): Promise<boolean>
Delete a file item from memory.
Parameters
- id: string
Returns Promise<boolean>
True when the item was deleted.
Implementation of DataItemDBDriver.deleteItem
- Defined in api/ORM/drivers/InMemoryFileItemDBDriver.ts:269

listItems

listItems(
    config: ListItemsConfig,
    selectFields?: (
        | "id"
        | "updatedOn"
        | "mimeType"
        | "sizeInBytes"
        | "isDirectory"
        | "uploadUrl"
        | "downloadUrl"
        | (keyof BaseFileLocationInfo)
    )[],
): Promise<ListItemsResults<Partial<BaseFileItem>>>
List file items from memory.
Parameters
- config: ListItemsConfig
  List configuration and criteria.
- OptionalselectFields: (
      | "id"
      | "updatedOn"
      | "mimeType"
      | "sizeInBytes"
      | "isDirectory"
      | "uploadUrl"
      | "downloadUrl"
      | (keyof BaseFileLocationInfo)
  )[]
  Optional fields to select from each file item.
Returns Promise<ListItemsResults<Partial<BaseFileItem>>>
List results with items and cursor.
Implementation of DataItemDBDriver.listItems
- Defined in api/ORM/drivers/InMemoryFileItemDBDriver.ts:288

readItem

readItem(
    uniqueIdentifier: string,
    selectFields?: (
        | "id"
        | "updatedOn"
        | "mimeType"
        | "sizeInBytes"
        | "isDirectory"
        | "uploadUrl"
        | "downloadUrl"
        | (keyof BaseFileLocationInfo)
    )[],
): Promise<Partial<BaseFileItem>>
Read a file item from memory.
Parameters
- uniqueIdentifier: string
  Unique identifier value for the file.
- OptionalselectFields: (
      | "id"
      | "updatedOn"
      | "mimeType"
      | "sizeInBytes"
      | "isDirectory"
      | "uploadUrl"
      | "downloadUrl"
      | (keyof BaseFileLocationInfo)
  )[]
  Optional fields to select from the file item.
Returns Promise<Partial<BaseFileItem>>
File item payload (partial when selected fields are used).
Implementation of DataItemDBDriver.readItem
- Defined in api/ORM/drivers/InMemoryFileItemDBDriver.ts:170

updateItem

updateItem(
uniqueIdentifier: string,
item: Partial<BaseFileItem>,
): Promise<boolean>
Update a file item in memory.
Parameters
- uniqueIdentifier: string
  Unique identifier value for the file.
- item: Partial<BaseFileItem>
  Partial update payload for the file.
Returns Promise<boolean>
True when the item was updated.
Implementation of DataItemDBDriver.updateItem
- Defined in api/ORM/drivers/InMemoryFileItemDBDriver.ts:208

Properties

`Protected`config

config: DataItemDBDriverConfig<BaseFileItem, "id">

Driver configuration including table name and config overrides.