Skip to main content

ValidationError

@rotorsoft/act-root

@rotorsoft/act-root / act/src / ValidationError

Class: ValidationError

Defined in: libs/act/src/types/errors.ts:69

Thrown when an action or event payload fails Zod schema validation.

This error indicates that data doesn't match the expected schema defined for an action or event. The details property contains the Zod validation error with specific information about what failed.

Examples​

import { ValidationError } from "@rotorsoft/act";

try {
  await app.do("createUser", target, {
    email: "invalid-email",  // Missing @ symbol
    age: -5                  // Negative age
  });
} catch (error) {
  if (error instanceof ValidationError) {
    console.error("Validation failed for:", error.target);
    console.error("Invalid payload:", error.payload);
    console.error("Validation details:", error.details);
    // details contains Zod error with field-level info
  }
}
try {
  await app.do("updateProfile", target, payload);
} catch (error) {
  if (error instanceof ValidationError) {
    error.details.errors.forEach((err) => {
      console.error(`Field ${err.path.join(".")}: ${err.message}`);
    });
  }
}

See​

Zod documentation for validation details

Extends​

  • Error

Constructors​

Constructor​

new ValidationError(target, payload, details): ValidationError

Defined in: libs/act/src/types/errors.ts:70

Parameters​

target​

string

The type of target being validated (e.g., "action", "event")

payload​

any

The invalid payload that failed validation

details​

any

Zod validation error details

Returns​

ValidationError

Overrides​

Error.constructor

Properties​

cause?​

optional cause?: unknown

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from​

Error.cause

details​

readonly details: any

Defined in: libs/act/src/types/errors.ts:76

Zod validation error details

message​

message: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from​

Error.message

name​

name: string

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

Inherited from​

Error.name

payload​

readonly payload: any

Defined in: libs/act/src/types/errors.ts:74

The invalid payload that failed validation

stack?​

optional stack?: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from​

Error.stack

target​

readonly target: string

Defined in: libs/act/src/types/errors.ts:72

The type of target being validated (e.g., "action", "event")

stackTraceLimit​

static stackTraceLimit: number

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

Error.stackTraceLimit

Methods​

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@25.9.1/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();

Parameters​

targetObject​

object

constructorOpt?​

Function

Returns​

void

Inherited from​

Error.captureStackTrace

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@25.9.1/node_modules/@types/node/globals.d.ts:55

Parameters​

err​

Error

stackTraces​

CallSite[]

Returns​

any

See​

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

Inherited from​

Error.prepareStackTrace