Defined in: packages/query-core/src/retryer.ts:120
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.
Example#
query.cancel()
try {
await query.promise
} catch (error) {
if (error instanceof CancelledError) {
// the fetch was cancelled, e.g. via `query.cancel()`
}
}
Extends#
Error
Constructors#
Constructor#
new CancelledError(options?: CancelOptions): CancelledError;
Defined in: packages/query-core/src/retryer.ts:123
Parameters#
options?#
Returns#
CancelledError
Overrides#
Error.constructor
Properties#
cause?#
optional cause?: unknown;
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24
Inherited from#
Error.cause
message#
message: string;
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075
Inherited from#
Error.message
name#
name: string;
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074
Inherited from#
Error.name
revert?#
optional revert?: boolean;
Defined in: packages/query-core/src/retryer.ts:121
silent?#
optional silent?: boolean;
Defined in: packages/query-core/src/retryer.ts:122
stack?#
optional stack?: string;
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from#
Error.stack
stackTraceLimit#
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.
Inherited from#
Error.stackTraceLimit
Methods#
captureStackTrace()#
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`
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#
targetObject#
object
constructorOpt?#
Function
Returns#
void
Inherited from#
Error.captureStackTrace
prepareStackTrace()#
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
Parameters#
err#
Error
stackTraces#
CallSite[]
Returns#
any
See#
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from#
Error.prepareStackTrace