@salesforce/b2c-tooling-sdk / scapi / ScapiCodeOptions
Interface: ScapiCodeOptions
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:21
Properties
auth()?
optionalauth: (operation,options,signal) =>Promise<unknown>
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:28
Parameters
operation
string
options
unknown
signal
AbortSignal
Returns
Promise<unknown>
authType?
optionalauthType:ScapiAuthType
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:26
code
code:
string
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:22
cwd?
optionalcwd:string
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:31
detail?
optionaldetail:"outline"|"full"
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:39
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?
optionaldocuments:ScapiSchemaDocument[]
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:25
input?
optionalinput:unknown
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:23
maxOutputBytes?
optionalmaxOutputBytes:number
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:34
onControl()?
optionalonControl: (control) =>void
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:41
The host owns cancellation and cleanup while paused; approval may wait indefinitely. Never exposed to the child.
Parameters
control
Returns
void
organizationId?
optionalorganizationId:string
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:29
request()?
optionalrequest: (options,signal) =>Promise<unknown>
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:27
Parameters
options
unknown
signal
AbortSignal
Returns
Promise<unknown>
signal?
optionalsignal:AbortSignal
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:32
siteId?
optionalsiteId:string
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:30
snippets?
optionalsnippets:ScapiSnippet[]
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:24
timeoutMs?
optionaltimeoutMs:number
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:33