API reference / @node-ts/bus-messages / MessageTypesConflict

Class: MessageTypesConflict

Defined in: packages/bus-messages/src/error/message-types-conflict.ts:10

Thrown when message types passed to the same bus define the same $name or type key differently, so it's ambiguous how to restore it

Extends

• Error

Constructors

Constructor

new MessageTypesConflict(
   kind, 
   key, 
   sources?
): MessageTypesConflict;

Defined in: packages/bus-messages/src/error/message-types-conflict.ts:18

Parameters

Parameter	Type	Default value	Description
kind	"$name" | "type"	undefined	whether a message $name or a type key conflicts
key	string	undefined	the $name or type key that is defined more than once
sources	(string | undefined)[]	[]	the source of the two message types that define it, where they have one

Returns

MessageTypesConflict

Overrides

Error.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
cause?	public	unknown	undefined	-	Error.cause	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24
help	readonly	string	undefined	-	-	packages/bus-messages/src/error/message-types-conflict.ts:11
key	readonly	string	undefined	the $name or type key that is defined more than once	-	packages/bus-messages/src/error/message-types-conflict.ts:20
kind	readonly	"$name" | "type"	undefined	whether a message $name or a type key conflicts	-	packages/bus-messages/src/error/message-types-conflict.ts:19
message	public	string	undefined	-	Error.message	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075
name	public	string	undefined	-	Error.name	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074
sources	readonly	(string | undefined)[]	[]	the source of the two message types that define it, where they have one	-	packages/bus-messages/src/error/message-types-conflict.ts:21
stack?	public	string	undefined	-	Error.stack	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076
stackTraceLimit	static	number	undefined	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.	Error.stackTraceLimit	node_modules/.pnpm/@types+node@24.19.0/node_modules/@types/node/globals.d.ts:68

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@types+node@24.19.0/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

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

---

isError()

static isError(error): error is Error;

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

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 prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@types+node@24.19.0/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace