---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../../modules.md) / [operations/ods](../index.md) / WaitForSandboxOptions

# Interface: WaitForSandboxOptions

Defined in: [packages/b2c-tooling-sdk/src/operations/ods/wait-for-sandbox.ts:105](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/ods/wait-for-sandbox.ts#L105)

Configuration options for [waitForSandbox](../functions/waitForSandbox.md) sandbox state polling.

## Properties

### onPoll()?

> `optional` **onPoll**: (`info`) => `void`

Defined in: [packages/b2c-tooling-sdk/src/operations/ods/wait-for-sandbox.ts:110](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/ods/wait-for-sandbox.ts#L110)

Optional callback invoked on each poll with current state

#### Parameters

##### info

[`WaitForSandboxPollInfo`](WaitForSandboxPollInfo.md)

#### Returns

`void`

***

### pollIntervalSeconds

> **pollIntervalSeconds**: `number`

Defined in: [packages/b2c-tooling-sdk/src/operations/ods/wait-for-sandbox.ts:108](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/ods/wait-for-sandbox.ts#L108)

Interval between status checks in seconds

***

### sandboxId

> **sandboxId**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/ods/wait-for-sandbox.ts:106](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/ods/wait-for-sandbox.ts#L106)

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](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/ods/wait-for-sandbox.ts#L111)

Optional custom sleep function (primarily for testing)

#### Parameters

##### ms

`number`

#### Returns

`Promise`\<`void`\>

***

### targetState

> **targetState**: [`SandboxState`](../type-aliases/SandboxState.md)

Defined in: [packages/b2c-tooling-sdk/src/operations/ods/wait-for-sandbox.ts:107](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/ods/wait-for-sandbox.ts#L107)

Desired sandbox state to wait for

***

### timeoutSeconds

> **timeoutSeconds**: `number`

Defined in: [packages/b2c-tooling-sdk/src/operations/ods/wait-for-sandbox.ts:109](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/ods/wait-for-sandbox.ts#L109)

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