Class InvariantError

An error that occurs when a task violates a logical condition that is assumed to be true at all times.

Hierarchy

Error
- InvariantError

Index

Constructors

Methods

captureStackTrace

Properties

cause? message name stack? prepareStackTrace? stackTraceLimit

Constructors

constructor

new InvariantError(message?): InvariantError
Parameters
- Optional message: string
Returns InvariantError
Inherited from Error.constructor
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1073
new InvariantError(message?, options?): InvariantError
Parameters
- Optional message: string
- Optional options: ErrorOptions
Returns InvariantError
Inherited from Error.constructor
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1073

Methods

`Static` captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void
Inherited from Error.captureStackTrace
- Defined in node_modules/.pnpm/@types+node@18.18.12/node_modules/@types/node/globals.d.ts:4

Properties

`Optional` cause

cause?: unknown

message

message: string

name

name: "InvariantError" = ...

`Optional` stack

stack?: string

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

- (err, stackTraces): any
- Optional override for formatting stack traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any
  See
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces

See

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

`Static` stackTraceLimit

stackTraceLimit: number