Class: TRPCClientError<TRouterOrProcedure>

Defined in: packages/client/src/TRPCClientError.ts:47

Extends

• Error

Type Parameters

Type Parameter
TRouterOrProcedure extends InferrableClientTypes

Implements

• TRPCClientErrorBase<inferErrorShape<TRouterOrProcedure>>

Constructors

new TRPCClientError()

new TRPCClientError<TRouterOrProcedure>(message, opts?): TRPCClientError<TRouterOrProcedure>

Defined in: packages/client/src/TRPCClientError.ts:63

Parameters

Parameter	Type
message	string
opts?	{ cause: Error; meta: Record<string, unknown>; result: Maybe<TRPCErrorResponse<inferErrorShape<TRouterOrProcedure>>>; }
opts.cause?	Error
opts.meta?	Record<string, unknown>
opts.result?	Maybe<TRPCErrorResponse<inferErrorShape<TRouterOrProcedure>>>

Returns

TRPCClientError<TRouterOrProcedure>

Overrides

Error.constructor

Properties

cause

readonly cause: undefined | Error

Defined in: packages/client/src/TRPCClientError.ts:53

Overrides

Error.cause

---

data

readonly data: Maybe<inferErrorShape<TRouterOrProcedure>["data"]>

Defined in: packages/client/src/TRPCClientError.ts:55

Implementation of

TRPCClientErrorBase.data

---

message

message: string

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

Implementation of

TRPCClientErrorBase.message

Inherited from

Error.message

---

meta

meta: undefined | Record<string, unknown>

Defined in: packages/client/src/TRPCClientError.ts:61

Additional meta data about the error In the case of HTTP-errors, we'll have response and potentially responseJSON here

---

name

name: string

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

Inherited from

Error.name

---

shape

readonly shape: Maybe<inferErrorShape<TRouterOrProcedure>>

Defined in: packages/client/src/TRPCClientError.ts:54

Implementation of

TRPCClientErrorBase.shape

---

stack?

optional stack: string

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

Inherited from

Error.stack

---

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@22.17.0/node_modules/@types/node/globals.d.ts:161

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()

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@22.17.0/node_modules/@types/node/globals.d.ts:145

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

js
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:

js
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();

js
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

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/bun-types@1.1.32/node_modules/bun-types/globals.d.ts:1630

Create .stack property on a target object

Parameters

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

---

from()

static from<TRouterOrProcedure>(_cause, opts): TRPCClientError<TRouterOrProcedure>

Defined in: packages/client/src/TRPCClientError.ts:87

Type Parameters

Type Parameter
TRouterOrProcedure extends InferrableClientTypes

Parameters

Parameter	Type
_cause	object | Error | TRPCErrorResponse<any>
opts	{ cause: Error; meta: Record<string, unknown>; }
opts.cause?	Error
opts.meta?	Record<string, unknown>

Returns

TRPCClientError<TRouterOrProcedure>

---

isError()

static isError(error): error is Error

Defined in: node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

Parameter	Type
error	unknown

Returns

error is Error

Inherited from

Error.isError

---

prepareStackTrace()?

static optional prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@22.17.0/node_modules/@types/node/globals.d.ts:149

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace