Class: ChannelClosedError

Makaio Framework / bus-core / ChannelClosedError

Class: ChannelClosedError

Defined in: ../../../packages/bus-core/src/errors/channel-closed-error.ts:7

Thrown when an operation is attempted on a closed DirectChannel. All pending requests are rejected with this error when a channel closes.

Extends

BusError

Constructors

Constructor

new ChannelClosedError(channelId): ChannelClosedError

Defined in: ../../../packages/bus-core/src/errors/channel-closed-error.ts:11

Parameters

channelId

string

The identifier of the channel that is closed

Returns

ChannelClosedError

Overrides

BusError.constructor

Properties

cause?

optional cause?: unknown

Defined in: ../../../node_modules/typescript/lib/lib.es2022.error.d.ts:24

The cause of the error.

Inherited from

BusError.cause

message

message: string

Defined in: ../../../node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from

BusError.message

name

name: string

Defined in: ../../../node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from

BusError.name

stack?

optional stack?: string

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

Inherited from

BusError.stack

subject?

readonly optional subject?: string

Defined in: ../../../packages/bus-core/src/errors/bus-error.ts:13

Fully-qualified subject name (namespace.subject) for the failed operation

Inherited from

BusError.subject

stackTraceLimit

static stackTraceLimit: number

Defined in: ../../../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

BusError.stackTraceLimit

Methods

captureStackTrace()

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: ../../../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

BusError.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: ../../../node_modules/bun-types/globals.d.ts:1042

Create .stack property on a target object

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

BusError.captureStackTrace

isError()

Call Signature

static isError(error): error is Error

Defined in: ../../../node_modules/typescript/lib/lib.esnext.error.d.ts:21

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

Parameters

error

unknown

Returns

error is Error

Inherited from

BusError.isError

Call Signature

static isError(value): value is Error

Defined in: ../../../node_modules/bun-types/globals.d.ts:1037

Check if a value is an instance of Error

Parameters

value

unknown

The value to check

Returns

value is Error

True if the value is an instance of Error, false otherwise

Inherited from

BusError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: ../../../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

BusError.prepareStackTrace