Skip to main content
Version: 0.17

Class: ClientError

A client-side error occurred while communicating with a remote server.

Hierarchy​

  • Exception

    ↳ ClientError

Constructors​

constructor​

β€’ new ClientError(description)

Parameters​

NameType
descriptionstring

Overrides​

Exception.constructor

Defined in​

packages/@orbit/jsonapi/src/lib/exceptions.ts:10

Properties​

data​

β€’ Optional data: unknown

Defined in​

packages/@orbit/jsonapi/src/lib/exceptions.ts:7


message​

β€’ message: string

Inherited from​

Exception.message

Defined in​

node_modules/typescript/lib/lib.es5.d.ts:1023


name​

β€’ name: string

Inherited from​

Exception.name

Defined in​

node_modules/typescript/lib/lib.es5.d.ts:1022


response​

β€’ Optional response: Response

Defined in​

packages/@orbit/jsonapi/src/lib/exceptions.ts:8


stack​

β€’ Optional stack: string

Inherited from​

Exception.stack

Defined in​

node_modules/typescript/lib/lib.es5.d.ts:1024


stackTraceLimit​

β–ͺ Static stackTraceLimit: number

Inherited from​

Exception.stackTraceLimit

Defined in​

node_modules/@types/node/globals.d.ts:13

Accessors​

description​

β€’ get description(): string

A synonym for message.

deprecated since v0.17, access message instead

Returns​

string

Inherited from​

Exception.description

Defined in​

packages/@orbit/core/dist/modules/exception.d.ts:10

Methods​

captureStackTrace​

β–Έ Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters​

NameType
targetObjectobject
constructorOpt?Function

Returns​

void

Inherited from​

Exception.captureStackTrace

Defined in​

node_modules/@types/node/globals.d.ts:4


prepareStackTrace​

β–Έ Static Optional prepareStackTrace(err, stackTraces): any

Optional override for formatting stack traces

see https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces

Parameters​

NameType
errError
stackTracesCallSite[]

Returns​

any

Inherited from​

Exception.prepareStackTrace

Defined in​

node_modules/@types/node/globals.d.ts:11