For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.10

Class: CamundaValidationError

Opt-In Subpath

The Effect API is an opt-in subpath (@camunda8/orchestration-cluster-api/effect) and requires the optional effect peer dependency. The main . entry stays Promise-based and pulls in zero Effect at runtime.

A request/response validation failure surfaced by the SDK.

Extends​

  • YieldableError<this> & object & Readonly<{ cause?: unknown; issues: string[]; message: string; operationId?: string; side: "request" | "response"; summary: string; }>

Constructors​

Constructor​

new CamundaValidationError(args): CamundaValidationError;

Parameters​

args​
cause?​

unknown

issues​

string[]

message​

string

operationId?​

string

side​

"request" | "response"

summary​

string

Returns​

CamundaValidationError

Inherited from​

Data.TaggedError('CamundaValidationError')<{
  readonly side: 'request' | 'response';
  readonly operationId?: string;
  readonly summary: string;
  readonly issues: string[];
  readonly message: string;
  readonly cause?: unknown;
}>.constructor

Properties​

issues​

readonly issues: string[];

Inherited from​

Data.TaggedError("CamundaValidationError").issues;

operationId?​

readonly optional operationId?: string;

Inherited from​

Data.TaggedError("CamundaValidationError").operationId;

side​

readonly side: "request" | "response";

Inherited from​

Data.TaggedError("CamundaValidationError").side;

summary​

readonly summary: string;

Inherited from​

Data.TaggedError("CamundaValidationError").summary;