Skip to main content
Version: 2.6

BuildClient

@hideconstructor

Hierarchy

  • ResourceClient
    • BuildClient

Index

Constructors

constructor

  • new BuildClient(options: ApiClientSubResourceOptions): BuildClient
  • Parameters

    • options: ApiClientSubResourceOptions

    Returns BuildClient

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

get

waitForFinish

  • Returns a promise that resolves with the finished Build object when the provided actor build finishes or with the unfinished Build object when the waitSecs timeout lapses. The promise is NOT rejected based on run status. You can inspect the status property of the Build 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 immediately start a run after a build finishes.


    Parameters

    Returns Promise<Build>