Skip to main content
Version: 2

DatasetClient <Data>

Hierarchy

  • ResourceClient
    • DatasetClient

Index

Properties

Methods

Properties

inheritedapifyClient

apifyClient: ApifyClient

inheritedbaseUrl

baseUrl: string

inheritedhttpClient

httpClient: HttpClient

optionalinheritedid

id?: string

optionalinheritedparams

params?: Record<string, unknown>

inheritedpublicBaseUrl

publicBaseUrl: string

inheritedresourcePath

resourcePath: string

optionalinheritedsafeId

safeId?: string

inheritedurl

url: string

Methods

createItemsPublicUrl

  • createItemsPublicUrl(options): Promise<string>

  • Generates a URL that can be used to access dataset items.

    If the client has permission to access the dataset's URL signing key, the URL will include a signature which will allow the link to work even without authentication.

    You can optionally control how long the signed URL should be valid using the expiresInSecs option. This value sets the expiration duration in seconds from the time the URL is generated. If not provided, the URL will not expire.

    Any other options (like limit or prefix) will be included as query parameters in the URL.

    Parameters

    Returns Promise<string>

delete

  • delete(): Promise<void>

downloadItems

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

get

  • get(): Promise<undefined | Dataset>

getStatistics

listItems

pushItems

  • pushItems(items): Promise<void>

update

  • update(newFields): Promise<Dataset>
Page Options