KeyValueStoreCollectionClient

Client for managing the collection of Key-value stores in your account.

Key-value stores are used to store arbitrary data records or files. This client provides methods to list, create, or get key-value stores by name.

@example

const client = new ApifyClient({ token: 'my-token' });
const storesClient = client.keyValueStores();

// List all key-value stores
const { items } = await storesClient.list();

// Get or create a key-value store by name
const store = await storesClient.getOrCreate('my-store');

@see

https://docs.apify.com/platform/storage/key-value-store

Hierarchy

• ResourceCollectionClient
  • KeyValueStoreCollectionClient

Index

Properties

• apifyClient
• baseUrl
• httpClient
• id
• params
• publicBaseUrl
• resourcePath
• safeId
• url

Methods

• getOrCreate
• list

Properties

inheritedapifyClient

apifyClient: ApifyClient

Inherited from ResourceCollectionClient.apifyClient

inheritedbaseUrl

baseUrl: string

Inherited from ResourceCollectionClient.baseUrl

inheritedhttpClient

httpClient: HttpClient

Inherited from ResourceCollectionClient.httpClient

optionalinheritedid

id?: string

Inherited from ResourceCollectionClient.id

optionalinheritedparams

params?: Record<string, unknown>

Inherited from ResourceCollectionClient.params

inheritedpublicBaseUrl

publicBaseUrl: string

Inherited from ResourceCollectionClient.publicBaseUrl

inheritedresourcePath

resourcePath: string

Inherited from ResourceCollectionClient.resourcePath

optionalinheritedsafeId

safeId?: string

Inherited from ResourceCollectionClient.safeId

inheritedurl

url: string

Inherited from ResourceCollectionClient.url

Methods

getOrCreate

• getOrCreate(name, options): Promise<KeyValueStore>

• Gets or creates a key-value store with the specified name.

  @see

  https://docs.apify.com/api/v2/key-value-stores-post

  ---

  Parameters

  • optionalname: string

    Name of the key-value store. If not provided, a default store is used.

  • optionaloptions: KeyValueStoreCollectionClientGetOrCreateOptions

    Additional options like schema.

  Returns Promise<KeyValueStore>

  The key-value store object.

list

• list(options): Promise<KeyValueStoreCollectionListResult> & AsyncIterable<KeyValueStore, any, any>

• Lists all Key-value stores.

  Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched items in a single API call is limited.

  const paginatedList = await client.list(options);

  Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are retrieved.

  for await (const singleItem of client.list(options)) {...}

  @see

  https://docs.apify.com/api/v2/key-value-stores-get

  ---

  Parameters

  • options: KeyValueStoreCollectionClientListOptions = {}

    Pagination options.

  Returns Promise<KeyValueStoreCollectionListResult> & AsyncIterable<KeyValueStore, any, any>

  A paginated iterator of Key-value stores.