Skip to main content

QueryError

Defined in: packages/core/src/errors.ts:10

Extends

Constructors

Constructor

new QueryError(message?): QueryError;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

ParameterType
message?string

Returns

QueryError

Inherited from

BaseError.constructor

Constructor

new QueryError(message?, options?): QueryError;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

ParameterType
message?string
options?ErrorOptions

Returns

QueryError

Inherited from

BaseError.constructor

Properties

cause?

optional cause: unknown;

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

BaseError.cause


message

message: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

BaseError.message


name

name: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

BaseError.name


stack?

optional stack: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

BaseError.stack


stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/@types/node/globals.d.ts:68

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

BaseError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/@types/node/globals.d.ts:52

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

ParameterType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

BaseError.captureStackTrace


from()

static from<T>(error, message?): BaseError;

Defined in: packages/core/src/errors.ts:2

Type Parameters

Type Parameter
T

Parameters

ParameterType
errorT
message?string

Returns

BaseError

Inherited from

BaseError.from


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

ParameterType
errorunknown

Returns

error is Error

Inherited from

BaseError.isError


prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/@types/node/globals.d.ts:56

Parameters

ParameterType
errError
stackTracesCallSite[]

Returns

any

See

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

Inherited from

BaseError.prepareStackTrace