Class: ResourceError\<ResourceType>

An error for a specific resource

Type parameters

Name	Type
ResourceType	extends Resource

Hierarchy

• ErrorResult

↳ ResourceError

↳↳ UnexpectedResourceError

↳↳ InvalidUriError

↳↳ UnsupportedNotificationError

↳↳ DisconnectedAttemptingReconnectError

↳↳ DisconnectedNotAttemptingReconnectError

Constructors

constructor

• new ResourceError\<ResourceType>(resource, message?): ResourceError\<ResourceType>

Type parameters

Name	Type
ResourceType	extends Resource\<string>

Parameters

Name	Type	Description
resource	ResourceType	-
message?	string	A custom message for the error

Returns

ResourceError\<ResourceType>

Overrides

ErrorResult.constructor

Defined in

packages/connected/src/results/error/ErrorResult.ts:46

Properties

isError

• Readonly isError: true

Always true

Inherited from

ErrorResult.isError

Defined in

packages/connected/src/results/error/ErrorResult.ts:16

---

message

• message: string

Inherited from

ErrorResult.message

Defined in

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

---

name

• name: string

Inherited from

ErrorResult.name

Defined in

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

---

resource

• Readonly resource: ResourceType

The resource that failed

Defined in

packages/connected/src/results/error/ErrorResult.ts:40

---

stack

• Optional stack: string

Inherited from

ErrorResult.stack

Defined in

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

---

type

• Readonly Abstract type: string

Indicates the specific type of error

Inherited from

ErrorResult.type

Defined in

packages/connected/src/results/error/ErrorResult.ts:11

---

uri

• Readonly uri: ResourceType["uri"]

The URI of the resource

Defined in

packages/connected/src/results/error/ErrorResult.ts:35

---

prepareStackTrace

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

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

Type declaration

▸ (err, stackTraces): any

Parameters

Name	Type
err	Error
stackTraces	CallSite[]

Returns

any

Inherited from

ErrorResult.prepareStackTrace

Defined in

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

---

stackTraceLimit

▪ Static stackTraceLimit: number

Inherited from

ErrorResult.stackTraceLimit

Defined in

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

Methods

captureStackTrace

▸ captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Name	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

ErrorResult.captureStackTrace

Defined in

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