Skip to main content
Version: 11.x

Class: TRPCClientError<TRouterOrProcedure>

Defined in: packages/client/dist/TRPCClientError.d.ts:10

Extends

  • Error

Type Parameters

Type Parameter
TRouterOrProcedure extends InferrableClientTypes

Implements

Constructors

new TRPCClientError()

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

Defined in: packages/client/dist/TRPCClientError.d.ts:19

Parameters

ParameterType
messagestring
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/dist/TRPCClientError.d.ts:11

Overrides

Error.cause


data

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

Defined in: packages/client/dist/TRPCClientError.d.ts:13

Implementation of

TRPCClientErrorBase.data


message

message: string

Defined in: node_modules/.pnpm/typescript@5.7.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/dist/TRPCClientError.d.ts:18

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.7.2/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name


shape

readonly shape: Maybe<inferErrorShape<TRouterOrProcedure>>

Defined in: packages/client/dist/TRPCClientError.d.ts:12

Implementation of

TRPCClientErrorBase.shape


stack?

optional stack: string

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

Inherited from

Error.stack


prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any

Defined in: node_modules/.pnpm/@types+node@20.17.19/node_modules/@types/node/globals.d.ts:98

Optional override for formatting stack traces

Parameters

ParameterType
errError
stackTracesCallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace


stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@20.17.19/node_modules/@types/node/globals.d.ts:100

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@20.17.19/node_modules/@types/node/globals.d.ts:91

Create .stack property on a target object

Parameters

ParameterType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace


from()

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

Defined in: packages/client/dist/TRPCClientError.d.ts:24

Type Parameters

Type Parameter
TRouterOrProcedure extends InferrableClientTypes

Parameters

ParameterType
_causeobject | Error | TRPCErrorResponse<any>
opts?{ meta: Record<string, unknown>; }
opts.meta?Record<string, unknown>

Returns

TRPCClientError<TRouterOrProcedure>