Defined in: packages/query-core/src/retryer.ts:81
The error thrown by a Retryer (and surfaced to query.promise/mutation) when a fetch is cancelled, e.g. via query.cancel(). revert, if true, tells the caller to restore the state the query was in before the fetch started instead of surfacing the error. silent, if true, tells the caller to suppress this error and instead resolve with the promise of the fetch that triggered the cancellation.
query.cancel()
try {
await query.promise
} catch (error) {
if (error instanceof CancelledError) {
// the fetch was cancelled, e.g. via `query.cancel()`
}
}
query.cancel()
try {
await query.promise
} catch (error) {
if (error instanceof CancelledError) {
// the fetch was cancelled, e.g. via `query.cancel()`
}
}
new CancelledError(options?: CancelOptions): CancelledError;
new CancelledError(options?: CancelOptions): CancelledError;
Defined in: packages/query-core/src/retryer.ts:84
CancelledError
Error.constructor
Error.constructor
optional cause: unknown;
optional cause: unknown;
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24
Error.cause
Error.cause
message: string;
message: string;
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075
Error.message
Error.message
name: string;
name: string;
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074
Error.name
Error.name
optional revert: boolean;
optional revert: boolean;
Defined in: packages/query-core/src/retryer.ts:82
optional silent: boolean;
optional silent: boolean;
Defined in: packages/query-core/src/retryer.ts:83
optional stack: string;
optional stack: string;
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076
Error.stack
Error.stack
static stackTraceLimit: number;
static stackTraceLimit: number;
Defined in: node_modules/.pnpm/@types+node@22.19.15/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.
Error.stackTraceLimit
Error.stackTraceLimit
static captureStackTrace(targetObject: object, constructorOpt?: Function): void;
static captureStackTrace(targetObject: object, constructorOpt?: Function): void;
Defined in: node_modules/.pnpm/@types+node@22.19.15/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`
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();
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();
object
Function
void
Error.captureStackTrace
Error.captureStackTrace
static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;
static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:56
Error
CallSite[]
any
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Error.prepareStackTrace
Error.prepareStackTrace