> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bijection.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Class: BijectionError<TData>

> Reference for the BijectionError class in bijection/values.

[values](/api/modules/values).BijectionError

## Type parameters

| Name | Type |
| :- | :- |
| `TData` | extends [`Value`](/api/modules/values#value) |

## Hierarchy

* `Error`

  ↳ **`BijectionError`**

## Constructors

### constructor

• **new BijectionError**\<`TData`>(`data`)

#### Type parameters

| Name | Type |
| :- | :- |
| `TData` | extends [`Value`](/api/modules/values#value) |

#### Parameters

| Name | Type |
| :- | :- |
| `data` | `TData` |

#### Overrides

Error.constructor

## Properties

### name

• **name**: `string` = `"BijectionError"`

#### Overrides

Error.name

***

### data

• **data**: `TData`

***

### \[IDENTIFYING\_FIELD]

• **\[IDENTIFYING\_FIELD]**: `boolean` = `true`

***

### stackTraceLimit

▪ `Static` **stackTraceLimit**: `number`

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

Error.stackTraceLimit

***

### cause

• `Optional` **cause**: `unknown`

#### Inherited from

Error.cause

***

### message

• **message**: `string`

#### Inherited from

Error.message

***

### stack

• `Optional` **stack**: `string`

#### Inherited from

Error.stack

## Methods

### captureStackTrace

▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`

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 theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
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 theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
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

| Name | Type |
| :- | :- |
| `targetObject` | `object` |
| `constructorOpt?` | `Function` |

#### Returns

`void`

#### Inherited from

Error.captureStackTrace

***

### prepareStackTrace

▸ `Static` **prepareStackTrace**(`err`, `stackTraces`): `any`

**`See`**

[https://v8.dev/docs/stack-trace-api#customizing-stack-traces](https://v8.dev/docs/stack-trace-api#customizing-stack-traces)

#### Parameters

| Name | Type |
| :- | :- |
| `err` | `Error` |
| `stackTraces` | `CallSite`\[] |

#### Returns

`any`

#### Inherited from

Error.prepareStackTrace