# Class: PixiError (/jsdoc/pixi-vn/index/classes/PixiError)



Defined in: [src/core/PixiError.ts:5](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/core/PixiError.ts#L5)

Extends [#extends]

* `Error`

Constructors [#constructors]

Constructor [#constructor]

\> **new PixiError**(`code`, `message`): `PixiError`

Defined in: [src/core/PixiError.ts:7](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/core/PixiError.ts#L7)

Parameters [#parameters]

code [#code]

[`ErrorCodeType`](/jsdoc/pixi-vn/index/type-aliases/ErrorCodeType)

message [#message]

`string`

Returns [#returns]

`PixiError`

Overrides [#overrides]

`Error.constructor`

Constructor [#constructor-1]

\> **new PixiError**(`code`, `message`, `type`, `data`, `parent?`): `PixiError`

Defined in: [src/core/PixiError.ts:8](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/core/PixiError.ts#L8)

Parameters [#parameters-1]

code [#code-1]

[`ErrorCodeType`](/jsdoc/pixi-vn/index/type-aliases/ErrorCodeType)

message [#message-1]

`string`

type [#type]

`"canvas"`

data [#data]

[`CanvasBaseItemMemory`](/jsdoc/pixi-vn/index/interfaces/CanvasBaseItemMemory) | [`CanvasBaseItemMemory`](/jsdoc/pixi-vn/index/interfaces/CanvasBaseItemMemory) & `ContainerOptions`\<`ContainerChild`>

parent? [#parent]

[`CanvasBaseItem`](/jsdoc/pixi-vn/index/classes/CanvasBaseItem)\<`any`>

Returns [#returns-1]

`PixiError`

Overrides [#overrides-1]

`Error.constructor`

Properties [#properties]

canvasElementInfo? [#canvaselementinfo]

\> `optional` &#x2A;*canvasElementInfo?**: [`CanvasBaseItemMemory`](/jsdoc/pixi-vn/index/interfaces/CanvasBaseItemMemory)

Defined in: [src/core/PixiError.ts:32](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/core/PixiError.ts#L32)

***

cause? [#cause]

\> `optional` &#x2A;*cause?**: `unknown`

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

Inherited from [#inherited-from]

`Error.cause`

***

code [#code-2]

\> **code**: [`ErrorCodeType`](/jsdoc/pixi-vn/index/type-aliases/ErrorCodeType)

Defined in: [src/core/PixiError.ts:6](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/core/PixiError.ts#L6)

***

message [#message-2]

\> **message**: `string`

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

Inherited from [#inherited-from-1]

`Error.message`

***

name [#name]

\> **name**: `string`

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

Inherited from [#inherited-from-2]

`Error.name`

***

parent? [#parent-1]

\> `optional` &#x2A;*parent?**: [`CanvasBaseItem`](/jsdoc/pixi-vn/index/classes/CanvasBaseItem)\<`any`>

Defined in: [src/core/PixiError.ts:33](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/core/PixiError.ts#L33)

***

stack? [#stack]

\> `optional` &#x2A;*stack?**: `string`

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

Inherited from [#inherited-from-3]

`Error.stack`

***

stackTraceLimit [#stacktracelimit]

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

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

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 [#inherited-from-4]

`Error.stackTraceLimit`

Methods [#methods]

captureStackTrace() [#capturestacktrace]

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

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

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 [#parameters-2]

targetObject [#targetobject]

`object`

constructorOpt? [#constructoropt]

`Function`

Returns [#returns-2]

`void`

Inherited from [#inherited-from-5]

`Error.captureStackTrace`

***

isError() [#iserror]

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

Defined in: node\_modules/typescript/lib/lib.esnext.error.d.ts:23

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

Parameters [#parameters-3]

error [#error]

`unknown`

Returns [#returns-3]

`error is Error`

Inherited from [#inherited-from-6]

`Error.isError`

***

prepareStackTrace() [#preparestacktrace]

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

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

Parameters [#parameters-4]

err [#err]

`Error`

stackTraces [#stacktraces]

`CallSite`\[]

Returns [#returns-4]

`any`

See [#see]

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

Inherited from [#inherited-from-7]

`Error.prepareStackTrace`