@salesforce/b2c-tooling-sdk / operations/ods / WaitForSandboxOptions

Interface: WaitForSandboxOptions

Defined in: packages/b2c-tooling-sdk/src/operations/ods/wait-for-sandbox.ts:105

Configuration options for waitForSandbox sandbox state polling.

Properties

onPoll()?

optional onPoll: (info) => void

Defined in: packages/b2c-tooling-sdk/src/operations/ods/wait-for-sandbox.ts:110

Optional callback invoked on each poll with current state

Parameters

info

WaitForSandboxPollInfo

Returns

void

---

pollIntervalSeconds

pollIntervalSeconds: number

Defined in: packages/b2c-tooling-sdk/src/operations/ods/wait-for-sandbox.ts:108

Interval between status checks in seconds

---

sandboxId

sandboxId: string

Defined in: packages/b2c-tooling-sdk/src/operations/ods/wait-for-sandbox.ts:106

ID of the sandbox to monitor

---

sleep()?

optional sleep: (ms) => Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/ods/wait-for-sandbox.ts:111

Optional custom sleep function (primarily for testing)

Parameters

ms

number

Returns

Promise<void>

---

targetState

targetState: SandboxState

Defined in: packages/b2c-tooling-sdk/src/operations/ods/wait-for-sandbox.ts:107

Desired sandbox state to wait for

---

timeoutSeconds

timeoutSeconds: number

Defined in: packages/b2c-tooling-sdk/src/operations/ods/wait-for-sandbox.ts:109

Maximum time to wait in seconds (0 = no timeout)