@my-swu/simulator-client

---

@my-swu/simulator-client / SdkValidationError

Class: SdkValidationError

Defined in: packages/ts-sdk/src/internal/errors.ts:71

Error thrown when a simulator payload does not match the generated schema.

The SDK throws this when response or socket payload validation fails. It is also thrown by direct parseSchema() calls.

Example:

import { parseSchema, SdkValidationError } from '@my-swu/simulator-client'

try {
  // This intentionally fails because the schema only allows status: 'ok'.
  parseSchema('health-response', { status: 'offline' })
}
catch (error) {
  if (error instanceof SdkValidationError) {
    console.error(error.schemaName, error.details)
  }
}

Example

import { SdkValidationError } from '@my-swu/simulator-client'

const validationError = new SdkValidationError(
  'payload does not match schema health-response',
  'health-response',
  ['/status must be equal to constant'],
)

console.log(validationError.schemaName)

See

https://simulator-sdk.my-swu.com/guide/errors

Extends

• Error

Constructors

Constructor

Example:

import { SdkValidationError } from '@my-swu/simulator-client'

// Details usually come from Ajv schema validation failures.
const message = 'payload does not match schema health-response'
const schemaName = 'health-response'
const details = ['/status must be equal to constant']

const validationError = new SdkValidationError(message, schemaName, details)

new SdkValidationError(message, schemaName, details): SdkValidationError

Defined in: packages/ts-sdk/src/internal/errors.ts:75

Creates one validation error with schema name and readable detail strings.

Parameters

message

string

schemaName

string

details

readonly string[]

Returns

SdkValidationError

Overrides

Error.constructor

Properties

cause?

Example:

import { SdkValidationError } from '@my-swu/simulator-client'

// Construct directly when testing validation error rendering.
const validationError = new SdkValidationError(
  'payload does not match schema health-response',
  'health-response',
  ['/status must be equal to constant'],
)

const { cause } = validationError

console.log(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

Example:

import { SdkValidationError } from '@my-swu/simulator-client'

// Construct directly when testing validation error rendering.
const validationError = new SdkValidationError(
  'payload does not match schema health-response',
  'health-response',
  ['/status must be equal to constant'],
)

const { details } = validationError

console.log(details)

readonly details: readonly string[]

Defined in: packages/ts-sdk/src/internal/errors.ts:78

---

message

Example:

import { SdkValidationError } from '@my-swu/simulator-client'

// Construct directly when testing validation error rendering.
const validationError = new SdkValidationError(
  'payload does not match schema health-response',
  'health-response',
  ['/status must be equal to constant'],
)

const { message } = validationError

console.log(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

Example:

import { SdkValidationError } from '@my-swu/simulator-client'

// Construct directly when testing validation error rendering.
const validationError = new SdkValidationError(
  'payload does not match schema health-response',
  'health-response',
  ['/status must be equal to constant'],
)

const { name } = validationError

console.log(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

---

schemaName

Example:

import { SdkValidationError } from '@my-swu/simulator-client'

// Construct directly when testing validation error rendering.
const validationError = new SdkValidationError(
  'payload does not match schema health-response',
  'health-response',
  ['/status must be equal to constant'],
)

const { schemaName } = validationError

console.log(schemaName)

readonly schemaName: string

Defined in: packages/ts-sdk/src/internal/errors.ts:77

---

stack?

Example:

import { SdkValidationError } from '@my-swu/simulator-client'

// Construct directly when testing validation error rendering.
const validationError = new SdkValidationError(
  'payload does not match schema health-response',
  'health-response',
  ['/status must be equal to constant'],
)

const { stack } = validationError

console.log(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

---

stackTraceLimit

Example:

Error.stackTraceLimit = 20

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@24.12.2/node_modules/@types/node/globals.d.ts:68

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

Example:

import { SdkValidationError } from '@my-swu/simulator-client'

// Details usually come from Ajv schema validation failures.
const message = 'payload does not match schema health-response'
const schemaName = 'health-response'
const details = ['/status must be equal to constant']

const validationError = new SdkValidationError(message, schemaName, details)
Error.captureStackTrace(validationError, SdkValidationError)

static captureStackTrace(targetObject, constructorOpt?): void

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

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

---

prepareStackTrace()

Example:

Error.prepareStackTrace = (error, stackTraces) => `${error.name}: ${stackTraces.length} frames`

static prepareStackTrace(err, stackTraces): any

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

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace