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

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

# Class: ScapiCodePausedError

Defined in: [packages/b2c-tooling-sdk/src/scapi/runtime.ts:83](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/scapi/runtime.ts#L83)

The execution paused; `journal` resumes it and `detail` is what the pausing call threw with.

## Extends

- [`ScapiCodeError`](ScapiCodeError.md)

## Constructors

### Constructor

> **new ScapiCodePausedError**(`journal`, `detail`, `message`): `ScapiCodePausedError`

Defined in: [packages/b2c-tooling-sdk/src/scapi/runtime.ts:84](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/scapi/runtime.ts#L84)

#### Parameters

##### journal

[`ScapiJournal`](../interfaces/ScapiJournal.md)

##### detail

`unknown`

##### message

`string`

#### Returns

`ScapiCodePausedError`

#### Overrides

[`ScapiCodeError`](ScapiCodeError.md).[`constructor`](ScapiCodeError.md#constructor)

## Properties

### cause?

> `optional` **cause**: `unknown`

Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26

#### Inherited from

[`ScapiCodeError`](ScapiCodeError.md).[`cause`](ScapiCodeError.md#cause)

***

### code

> `readonly` **code**: `string`

Defined in: [packages/b2c-tooling-sdk/src/scapi/errors.ts:16](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/scapi/errors.ts#L16)

#### Inherited from

[`ScapiCodeError`](ScapiCodeError.md).[`code`](ScapiCodeError.md#code)

***

### detail

> `readonly` **detail**: `unknown`

Defined in: [packages/b2c-tooling-sdk/src/scapi/runtime.ts:86](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/scapi/runtime.ts#L86)

***

### journal

> `readonly` **journal**: [`ScapiJournal`](../interfaces/ScapiJournal.md)

Defined in: [packages/b2c-tooling-sdk/src/scapi/runtime.ts:85](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/scapi/runtime.ts#L85)

***

### message

> **message**: `string`

Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077

#### Inherited from

[`ScapiCodeError`](ScapiCodeError.md).[`message`](ScapiCodeError.md#message)

***

### name

> **name**: `string`

Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076

#### Inherited from

[`ScapiCodeError`](ScapiCodeError.md).[`name`](ScapiCodeError.md#name)

***

### stack?

> `optional` **stack**: `string`

Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078

#### Inherited from

[`ScapiCodeError`](ScapiCodeError.md).[`stack`](ScapiCodeError.md#stack)

***

### stackTraceLimit

> `static` **stackTraceLimit**: `number`

Defined in: node\_modules/@types/node/globals.d.ts:68

The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
`Error.captureStackTrace(obj)`).

The default value is `10` but may be set to any valid JavaScript number. Changes
will affect any stack trace captured _after_ the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.

#### Inherited from

[`ScapiCodeError`](ScapiCodeError.md).[`stackTraceLimit`](ScapiCodeError.md#stacktracelimit)

## Methods

### captureStackTrace()

> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`

Defined in: node\_modules/@types/node/globals.d.ts:52

Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
`Error.captureStackTrace()` was called.

```js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`
```

The first line of the trace will be prefixed with
`${myObject.name}: ${myObject.message}`.

The optional `constructorOpt` argument accepts a function. If given, all frames
above `constructorOpt`, including `constructorOpt`, will be omitted from the
generated stack trace.

The `constructorOpt` argument is useful for hiding implementation
details of error generation from the user. For instance:

```js
function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();
```

#### Parameters

##### targetObject

`object`

##### constructorOpt?

`Function`

#### Returns

`void`

#### Inherited from

[`ScapiCodeError`](ScapiCodeError.md).[`captureStackTrace`](ScapiCodeError.md#capturestacktrace)

***

### prepareStackTrace()

> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`

Defined in: node\_modules/@types/node/globals.d.ts:56

#### Parameters

##### err

`Error`

##### stackTraces

`CallSite`[]

#### Returns

`any`

#### See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

#### Inherited from

[`ScapiCodeError`](ScapiCodeError.md).[`prepareStackTrace`](ScapiCodeError.md#preparestacktrace)
