DatasetClient <Data>

@hideconstructor

Hierarchy

• ResourceClient
  • DatasetClient

Index

Constructors

• constructor

Properties

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

Methods

• delete
• downloadItems
• get
• listItems
• pushItems
• update

Constructors

constructor

• new DatasetClient<Data>(options: ApiClientSubResourceOptions): DatasetClient<Data>

• Overrides ResourceClient.constructor

  Type parameters

  • Data: Record<string | number, any> = Record<string | number, unknown>

  Parameters

  • options: ApiClientSubResourceOptions

  Returns DatasetClient<Data>

Properties

apifyClient

apifyClient: ApifyClient

Inherited from ResourceClient.apifyClient

baseUrl

baseUrl: string

Inherited from ResourceClient.baseUrl

httpClient

httpClient: HttpClient

Inherited from ResourceClient.httpClient

optionalid

id?: string

Inherited from ResourceClient.id

optionalparams

params?: Record<string, unknown>

Inherited from ResourceClient.params

resourcePath

resourcePath: string

Inherited from ResourceClient.resourcePath

optionalsafeId

safeId?: string

Inherited from ResourceClient.safeId

url

url: string

Inherited from ResourceClient.url

Methods

delete

• delete(): Promise<void>

• https://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset

  ---

  Returns Promise<void>

downloadItems

• downloadItems(format: DownloadItemsFormat, options?: DatasetClientDownloadItemsOptions): Promise<Buffer>

• Unlike listItems which returns a PaginationList with an array of individual dataset items, downloadItems returns the items serialized to the provided format. https://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items

  ---

  Parameters

  • format: DownloadItemsFormat

  • options: DatasetClientDownloadItemsOptions = {}

  Returns Promise<Buffer>

get

• get(): Promise<undefined | Dataset>

• https://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset

  ---

  Returns Promise<undefined | Dataset>

listItems

• listItems(options?: DatasetClientListItemOptions): Promise<PaginatedList<Data>>

• https://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items

  ---

  Parameters

  • options: DatasetClientListItemOptions = {}

  Returns Promise<PaginatedList<Data>>

pushItems

• pushItems(items: string | string[] | Data | Data[]): Promise<void>

• https://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items

  ---

  Parameters

  • items: string | string[] | Data | Data[]

  Returns Promise<void>

update

• update(newFields: DatasetClientUpdateOptions): Promise<Dataset>

• https://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset

  ---

  Parameters

  • newFields: DatasetClientUpdateOptions

  Returns Promise<Dataset>