---
title: "OptionsError"
---
# OptionsError

Defined in: [src/core/helpers/utils/error/errors/options-error.ts:11](https://github.com/xdan/jodit/blob/main/src/core/helpers/utils/error/errors/options-error.ts#L11)

## Extends

- [`TypeError`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypeError)

### Constructor

**new OptionsError**(`m`): `OptionsError`

Defined in: [src/core/helpers/utils/error/errors/options-error.ts:12](https://github.com/xdan/jodit/blob/main/src/core/helpers/utils/error/errors/options-error.ts#L12)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `m` | `string` |

#### Returns

`OptionsError`

#### Overrides

`TypeError.constructor`

### stackTraceLimit

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

Defined in: [../@types/node/globals.d.ts:67](https://github.com/xdan/jodit/blob/main/../@types/node/globals.d.ts#L67)

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

`TypeError.stackTraceLimit`

***

### cause?

`optional` **cause?**: `unknown`

Defined in: [../typescript/lib/lib.es2022.error.d.ts:26](https://github.com/xdan/jodit/blob/main/../typescript/lib/lib.es2022.error.d.ts#L26)

#### Inherited from

`TypeError.cause`

***

### name

**name**: `string`

Defined in: [../typescript/lib/lib.es5.d.ts:1076](https://github.com/xdan/jodit/blob/main/../typescript/lib/lib.es5.d.ts#L1076)

#### Inherited from

`TypeError.name`

***

### message

**message**: `string`

Defined in: [../typescript/lib/lib.es5.d.ts:1077](https://github.com/xdan/jodit/blob/main/../typescript/lib/lib.es5.d.ts#L1077)

#### Inherited from

`TypeError.message`

***

### stack?

`optional` **stack?**: `string`

Defined in: [../typescript/lib/lib.es5.d.ts:1078](https://github.com/xdan/jodit/blob/main/../typescript/lib/lib.es5.d.ts#L1078)

#### Inherited from

`TypeError.stack`

### captureStackTrace()

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

Defined in: [../@types/node/globals.d.ts:51](https://github.com/xdan/jodit/blob/main/../@types/node/globals.d.ts#L51)

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

| Parameter | Type |
| ------ | ------ |
| `targetObject` | `object` |
| `constructorOpt?` | [`Function`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function) |

#### Returns

`void`

#### Inherited from

`TypeError.captureStackTrace`

***

### prepareStackTrace()

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

Defined in: [../@types/node/globals.d.ts:55](https://github.com/xdan/jodit/blob/main/../@types/node/globals.d.ts#L55)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `err` | [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error) |
| `stackTraces` | `CallSite`[] |

#### Returns

`any`

#### See

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

#### Inherited from

`TypeError.prepareStackTrace`

***

### isError()

`static` **isError**(`error`): `error is Error`

Defined in: [../typescript/lib/lib.esnext.error.d.ts:23](https://github.com/xdan/jodit/blob/main/../typescript/lib/lib.esnext.error.d.ts#L23)

Indicates whether the argument provided is a built-in Error instance or not.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `error` | `unknown` |

#### Returns

`error is Error`

#### Inherited from

`TypeError.isError`