InvalidValueException

Defined in: packages/ddd-core/domain/exceptions/invalid-value.exception.ts:56

A value broke a rule of a textRule or numberRule.

It is the error both rules throw by default, and the base class for an application’s own exceptions, which then share its message format and its violation. domainErrorHttpStatus() answers 400 for it, like any other DomainException.

The rejected value is not kept, so logging the exception cannot leak it.

Example

export class InvalidUsernameException extends InvalidValueException {}

const username = textRule({
  field: 'username',
  minLength: 3,
  error: (violation) => new InvalidUsernameException(violation),
});

username.normalize('ab');
// throws InvalidUsernameException: "username must be at least 3 characters."

Extends

DomainException

Constructors

Constructor

new InvalidValueException(violation, message?): InvalidValueException

Defined in: packages/ddd-core/domain/exceptions/invalid-value.exception.ts:63

Parameters

violation

ValueViolation

The broken rule.

message?

string

Replaces the default message built from violation.

Returns

InvalidValueException

Overrides

DomainException.constructor

Properties

cause?

optional cause?: unknown

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

Inherited from

DomainException.cause

message

message: string

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

Inherited from

DomainException.message

name

name: string

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

Inherited from

DomainException.name

stack?

optional stack?: string

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

Inherited from

DomainException.stack

violation

readonly violation: ValueViolation

Defined in: packages/ddd-core/domain/exceptions/invalid-value.exception.ts:57

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@26.6.3/node_modules/@types/node/globals.d.ts:67

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

DomainException.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@26.6.3/node_modules/@types/node/globals.d.ts:51

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();