Skip to main content

Interface: BundleWaitOptions

Gala Launchpad SDK 9.0.0-rc.5

Gala Launchpad SDK 9.0.0-rc.5 / index / BundleWaitOptions

Interface: BundleWaitOptions

Defined in: packages/launchpad-sdk/dist/launchpad/bundle-submission.d.ts:16

Options accepted by BundleSubmission.wait.

Properties​

pollIntervalMs?​

optional pollIntervalMs?: number

Defined in: packages/launchpad-sdk/dist/launchpad/bundle-submission.d.ts:20

Pause between confirmation reads (default 2.5 s); a read that failed is repeated after it too.

signal?​

optional signal?: AbortSignal

Defined in: packages/launchpad-sdk/dist/launchpad/bundle-submission.d.ts:29

Stop waiting. An aborted wait rejects with LaunchpadSDKError BUNDLE_WAIT_ABORTED and stops everything it started (its reads, their pause, its deadline timer, its socket listener; a socket the transport opened is disconnected, a borrowed bundleSocketFactory socket is not). Aborting stops WATCHING only: the bundle may still be processed, and attach resumes it. A signal that is already aborted rejects at once, before a socket is opened or a read is sent.

Since​

9.0.0

timeoutMs?​

optional timeoutMs?: number

Defined in: packages/launchpad-sdk/dist/launchpad/bundle-submission.d.ts:18

How long to wait in all (default 60 s). The deadline ends the wait with BUNDLE_CONFIRMATION_TIMEOUT.