KeyValueStoreClient

Hierarchy

• ResourceClient
  • KeyValueStoreClient

Index

Properties

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

Methods

• delete
• deleteRecord
• get
• getRecord
• listKeys
• recordExists
• setRecord
• update

Properties

inheritedapifyClient

apifyClient: ApifyClient

Inherited from ResourceClient.apifyClient

inheritedbaseUrl

baseUrl: string

Inherited from ResourceClient.baseUrl

inheritedhttpClient

httpClient: HttpClient

Inherited from ResourceClient.httpClient

optionalinheritedid

id?: string

Inherited from ResourceClient.id

optionalinheritedparams

params?: Record<string, unknown>

Inherited from ResourceClient.params

inheritedresourcePath

resourcePath: string

Inherited from ResourceClient.resourcePath

optionalinheritedsafeId

safeId?: string

Inherited from ResourceClient.safeId

inheritedurl

url: string

Inherited from ResourceClient.url

Methods

delete

• delete(): Promise<void>

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

  ---

  Returns Promise<void>

deleteRecord

• deleteRecord(key: string): Promise<void>

• https://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record

  ---

  Parameters

  • key: string

  Returns Promise<void>

get

• get(): Promise<undefined | KeyValueStore>

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

  ---

  Returns Promise<undefined | KeyValueStore>

getRecord

• getRecord(key: string): Promise<undefined | KeyValueStoreRecord<JsonValue>>
• getRecord(key: string, options: Options): Promise<undefined | KeyValueStoreRecord<ReturnTypeFromOptions<Options>>>

• You can use the buffer option to get the value in a Buffer (Node.js) or ArrayBuffer (browser) format. In Node.js (not in browser) you can also use the stream option to get a Readable stream.

  When the record does not exist, the function resolves to undefined. It does NOT resolve to a KeyValueStore record with an undefined value. https://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record

  ---

  Parameters

  • key: string

  Returns Promise<undefined | KeyValueStoreRecord<JsonValue>>

listKeys

• listKeys(options?: KeyValueClientListKeysOptions): Promise<KeyValueClientListKeysResult>

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

  ---

  Parameters

  • options: KeyValueClientListKeysOptions = {}

  Returns Promise<KeyValueClientListKeysResult>

recordExists

• recordExists(key: string): Promise<boolean>

• Tests whether a record with the given key exists in the key-value store without retrieving its value.

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

  ---

  Parameters

  • key: string

    The queried record key.

  Returns Promise<boolean>

  true if the record exists, false if it does not.

setRecord

• setRecord(record: KeyValueStoreRecord<JsonValue>): Promise<void>

• The value in the record can be a stream object (detected by having the .pipe and .on methods). However, note that in that case following redirects or retrying the request if it fails (for example due to rate limiting) isn't possible. If you want to keep that behavior, you need to collect the whole stream contents into a Buffer and then send the full buffer. See this StackOverflow answer for an example how to do that.

  https://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record

  ---

  Parameters

  • record: KeyValueStoreRecord<JsonValue>

  Returns Promise<void>

update

• update(newFields: KeyValueClientUpdateOptions): Promise<KeyValueStore>

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

  ---

  Parameters

  • newFields: KeyValueClientUpdateOptions

  Returns Promise<KeyValueStore>