Skip to main content
Version: 2.6

KeyValueStoreClient

@hideconstructor

Hierarchy

  • ResourceClient
    • KeyValueStoreClient

Index

Constructors

constructor

  • Parameters

    • options: ApiClientSubResourceOptions

    Returns KeyValueStoreClient

Properties

apifyClient

apifyClient: ApifyClient

baseUrl

baseUrl: string

httpClient

httpClient: HttpClient

optionalid

id?: string

optionalparams

params?: Record<string, unknown>

resourcePath

resourcePath: string

optionalsafeId

safeId?: string

url

url: string

Methods

delete

  • delete(): Promise<void>

deleteRecord

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

get

getRecord

  • 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

setRecord

update