Skip to main content
Version: Next

RunClient

Hierarchy

  • ResourceClient
    • RunClient

Index

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

abort

dataset

delete

  • delete(): Promise<void>

get

  • get(options): Promise<undefined | ActorRun>

keyValueStore

log

metamorph

  • metamorph(targetActorId, input, options): Promise<ActorRun>

reboot

requestQueue

resurrect

update

waitForFinish

  • waitForFinish(options): Promise<ActorRun>
  • Returns a promise that resolves with the finished Run object when the provided actor run finishes or with the unfinished Run object when the waitSecs timeout lapses. The promise is NOT rejected based on run status. You can inspect the status property of the Run object to find out its status.

    The difference between this function and the waitForFinish parameter of the get method is the fact that this function can wait indefinitely. Its use is preferable to the waitForFinish parameter alone, which it uses internally.

    This is useful when you need to chain actor executions. Similar effect can be achieved by using webhooks, so be sure to review which technique fits your use-case better.


    Parameters

    Returns Promise<ActorRun>