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

[@salesforce/b2c-tooling-sdk](../../modules.md) / [scapi](../index.md) / ScapiCodeOptions

# Interface: ScapiCodeOptions

Defined in: [packages/b2c-tooling-sdk/src/scapi/runtime.ts:21](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/runtime.ts#L21)

## Properties

### auth()?

> `optional` **auth**: (`operation`, `options`, `signal`) => `Promise`\<`unknown`\>

Defined in: [packages/b2c-tooling-sdk/src/scapi/runtime.ts:28](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/runtime.ts#L28)

#### Parameters

##### operation

`string`

##### options

`unknown`

##### signal

`AbortSignal`

#### Returns

`Promise`\<`unknown`\>

***

### authType?

> `optional` **authType**: [`ScapiAuthType`](../type-aliases/ScapiAuthType.md)

Defined in: [packages/b2c-tooling-sdk/src/scapi/runtime.ts:26](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/runtime.ts#L26)

***

### code

> **code**: `string`

Defined in: [packages/b2c-tooling-sdk/src/scapi/runtime.ts:22](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/runtime.ts#L22)

***

### cwd?

> `optional` **cwd**: `string`

Defined in: [packages/b2c-tooling-sdk/src/scapi/runtime.ts:31](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/runtime.ts#L31)

***

### detail?

> `optional` **detail**: `"full"` \| `"outline"`

Defined in: [packages/b2c-tooling-sdk/src/scapi/runtime.ts:39](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/runtime.ts#L39)

How much prose `spec` operations carry. `outline` keeps each operation's own summary, description and tags but
drops nested descriptions and examples, keeping discovery results within the output cap. Defaults to `full`.

***

### documents?

> `optional` **documents**: [`ScapiSchemaDocument`](ScapiSchemaDocument.md)[]

Defined in: [packages/b2c-tooling-sdk/src/scapi/runtime.ts:25](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/runtime.ts#L25)

***

### input?

> `optional` **input**: `unknown`

Defined in: [packages/b2c-tooling-sdk/src/scapi/runtime.ts:23](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/runtime.ts#L23)

***

### maxOutputBytes?

> `optional` **maxOutputBytes**: `number`

Defined in: [packages/b2c-tooling-sdk/src/scapi/runtime.ts:34](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/runtime.ts#L34)

***

### onControl()?

> `optional` **onControl**: (`control`) => `void`

Defined in: [packages/b2c-tooling-sdk/src/scapi/runtime.ts:41](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/runtime.ts#L41)

The host owns cancellation and cleanup while paused; approval may wait indefinitely. Never exposed to the child.

#### Parameters

##### control

[`ScapiRuntimeControl`](ScapiRuntimeControl.md)

#### Returns

`void`

***

### organizationId?

> `optional` **organizationId**: `string`

Defined in: [packages/b2c-tooling-sdk/src/scapi/runtime.ts:29](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/runtime.ts#L29)

***

### request()?

> `optional` **request**: (`options`, `signal`) => `Promise`\<`unknown`\>

Defined in: [packages/b2c-tooling-sdk/src/scapi/runtime.ts:27](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/runtime.ts#L27)

#### Parameters

##### options

`unknown`

##### signal

`AbortSignal`

#### Returns

`Promise`\<`unknown`\>

***

### signal?

> `optional` **signal**: `AbortSignal`

Defined in: [packages/b2c-tooling-sdk/src/scapi/runtime.ts:32](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/runtime.ts#L32)

***

### siteId?

> `optional` **siteId**: `string`

Defined in: [packages/b2c-tooling-sdk/src/scapi/runtime.ts:30](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/runtime.ts#L30)

***

### snippets?

> `optional` **snippets**: [`ScapiSnippet`](ScapiSnippet.md)[]

Defined in: [packages/b2c-tooling-sdk/src/scapi/runtime.ts:24](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/runtime.ts#L24)

***

### timeoutMs?

> `optional` **timeoutMs**: `number`

Defined in: [packages/b2c-tooling-sdk/src/scapi/runtime.ts:33](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/runtime.ts#L33)