Open Cap Table Protocol Canton SDK - v0.2.224
    Preparing search index...

    Class OcpValidationError

    Validation errors for invalid input data.

    Thrown when input data fails validation before being sent to DAML contracts. Includes the field path where validation failed and optionally the expected type and received value.

    if (!data.id) {
      throw new OcpValidationError('stakeholder.id', 'Required field is missing or empty', {
        expectedType: 'string',
        receivedValue: data.id,
      });
    }

    try {
      await ocp.OpenCapTable.capTable.update(...).create('stakeholder', data).execute();
    } catch (error) {
      if (error instanceof OcpValidationError) {
        console.error(`Validation failed at '${error.fieldPath}': ${error.message}`);
        console.error(`Expected: ${error.expectedType}, Got: ${error.receivedValue}`);
      }
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    cause? code expectedType? fieldPath message name receivedValue? stack? stackTraceLimit

    Methods

    captureStackTrace prepareStackTrace

    Constructors

    Properties

    cause?: Error

    The original error that caused this error, if any

    code: OcpErrorCode

    Error code for programmatic handling

    expectedType?: string

    The expected type for this field, if applicable

    fieldPath: string

    The dot-separated path to the field that failed validation

    message: string
    name: string
    receivedValue?: unknown

    The actual value that was received

    stack?: string
    stackTraceLimit: number

    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.

    Methods

    • 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
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods