Class DataStores

constructor

• new DataStores(fetch: FetchFunction): DataStores

  Create a new DataStores instance.

  Parameters

  • fetch: FetchFunction

    Function for making API requests

  Returns DataStores

Readonlyrecords

create

• create(body: CreateDataStoreBody): Promise<DataStore>

  Create a new data store.

  Parameters

  • body: CreateDataStoreBody

    Parameters for the data store to create

  Returns Promise<DataStore>

  Promise with the created data store

delete

• delete(dataStoreId: number): Promise<void>

  Delete a data store.

  Parameters

  • dataStoreId: number

    The data store ID to delete

  Returns Promise<void>

  Promise that resolves when the data store is deleted

get

• get<C extends keyof DataStore = never>(
      dataStoreId: number,
      options?: GetDataStoreOptions<C>,
  ): Promise<
      PickColumns<
          DataStore,
          C,
          "name"
          | "id"
          | "teamId"
          | "records"
          | "size"
          | "maxSize",
      >,
  >

  Get data store details by ID.

  Type Parameters

  • C extends keyof DataStore = never

  Parameters

  • dataStoreId: number

    The data store ID to retrieve
  • Optionaloptions: GetDataStoreOptions<C>

  Returns Promise<
      PickColumns<
          DataStore,
          C,
          "name"
          | "id"
          | "teamId"
          | "records"
          | "size"
          | "maxSize",
      >,
  >

  Promise with the data store details

list

• list<C extends keyof DataStore = never>(
      teamId: number,
      options?: ListDataStoresOptions<C>,
  ): Promise<
      PickColumns<
          DataStore,
          C,
          "name"
          | "id"
          | "teamId"
          | "records"
          | "size"
          | "maxSize",
      >[],
  >

  List all data stores for a team.

  Type Parameters

  • C extends keyof DataStore = never

  Parameters

  • teamId: number

    The team ID to filter data stores by
  • Optionaloptions: ListDataStoresOptions<C>

    Optional parameters for filtering and pagination

  Returns Promise<
      PickColumns<
          DataStore,
          C,
          "name"
          | "id"
          | "teamId"
          | "records"
          | "size"
          | "maxSize",
      >[],
  >

  Promise with the list of data stores

update

• update(dataStoreId: number, body: UpdateDataStoreBody): Promise<DataStore>

  Update a data store.

  Parameters

  • dataStoreId: number

    The data store ID to update
  • body: UpdateDataStoreBody

    The data store properties to update

  Returns Promise<DataStore>

  Promise with the updated data store