KeyValueStoreCollectionClient

@hideconstructor

Hierarchy

• ResourceCollectionClient
  • KeyValueStoreCollectionClient

Index

Constructors

• constructor

Properties

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

Methods

• getOrCreate
• list

Constructors

constructor

• new KeyValueStoreCollectionClient(options: ApiClientSubResourceOptions): KeyValueStoreCollectionClient

• Overrides ResourceCollectionClient.constructor

  Parameters

  • options: ApiClientSubResourceOptions

  Returns KeyValueStoreCollectionClient

Properties

apifyClient

apifyClient: ApifyClient

Inherited from ResourceCollectionClient.apifyClient

baseUrl

baseUrl: string

Inherited from ResourceCollectionClient.baseUrl

httpClient

httpClient: HttpClient

Inherited from ResourceCollectionClient.httpClient

optionalid

id?: string

Inherited from ResourceCollectionClient.id

optionalparams

params?: Record<string, unknown>

Inherited from ResourceCollectionClient.params

resourcePath

resourcePath: string

Inherited from ResourceCollectionClient.resourcePath

optionalsafeId

safeId?: string

Inherited from ResourceCollectionClient.safeId

url

url: string

Inherited from ResourceCollectionClient.url

Methods

getOrCreate

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

• https://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store

  ---

  Parameters

  • optionalname: string

  • optionaloptions: KeyValueStoreCollectionClientGetOrCreateOptions

  Returns Promise<KeyValueStore>

list

• list(options?: KeyValueStoreCollectionClientListOptions): Promise<PaginatedList<KeyValueStoreCollectionListResult>>

• https://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores

  ---

  Parameters

  • options: KeyValueStoreCollectionClientListOptions = {}

  Returns Promise<PaginatedList<KeyValueStoreCollectionListResult>>