Skip to main content

Class: ConvexError<TData>

values.ConvexError

Type parameters​

NameType
TDataextends Value

Hierarchy​

  • Error

    ↳ ConvexError

Constructors​

constructor​

• new ConvexError<TData>(data)

Type parameters​

NameType
TDataextends Value

Parameters​

NameType
dataTData

Overrides​

Error.constructor

Defined in​

values/errors.ts:10

Properties​

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

Defined in​

../../common/temp/node_modules/.pnpm/@types+node@18.19.130/node_modules/@types/node/globals.d.ts:68

cause​

• Optional cause: unknown

Inherited from​

Error.cause

Defined in​

../../common/temp/node_modules/.pnpm/typescript@5.0.4/node_modules/typescript/lib/lib.es2022.error.d.ts:24

message​

• message: string

Inherited from​

Error.message

Defined in​

../../common/temp/node_modules/.pnpm/typescript@5.0.4/node_modules/typescript/lib/lib.es5.d.ts:1055

stack​

• Optional stack: string

Inherited from​

Error.stack

Defined in​

../../common/temp/node_modules/.pnpm/typescript@5.0.4/node_modules/typescript/lib/lib.es5.d.ts:1056

name​

• name: string = "ConvexError"

Overrides​

Error.name

Defined in​

values/errors.ts:6

data​

• data: TData

Defined in​

values/errors.ts:7

[IDENTIFYING_FIELD]​

• [IDENTIFYING_FIELD]: boolean = true

Defined in​

values/errors.ts:8

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.

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:

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​

NameType
targetObjectobject
constructorOpt?Function

Returns​

void

Inherited from​

Error.captureStackTrace

Defined in​

../../common/temp/node_modules/.pnpm/@types+node@18.19.130/node_modules/@types/node/globals.d.ts:52

prepareStackTrace​

▸ Static prepareStackTrace(err, stackTraces): any

See

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

Parameters​

NameType
errError
stackTracesCallSite[]

Returns​

any

Inherited from​

Error.prepareStackTrace

Defined in​

../../common/temp/node_modules/.pnpm/@types+node@18.19.130/node_modules/@types/node/globals.d.ts:56