@my-swu/simulator-client

---

@my-swu/simulator-client / parseSchema

Function: parseSchema()

parseSchema<TName>(name, value): SchemaTypeMap[TName]

Defined in: packages/ts-sdk/src/validators.ts:104

Validates one unknown payload against one generated schema.

Use this for custom transports, persisted payload checks, tests, or tools that need the same runtime validation the SDK applies at the network boundary.

Example:

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

// Parsed values are runtime-validated and statically typed.
const health = parseSchema('health-response', { status: 'ok' })

console.log(health.status)

Type Parameters

TName

Example:

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

// Parsed values are runtime-validated and statically typed.
const health = parseSchema('health-response', { status: 'ok' })

console.log(health.status)

TName extends keyof SchemaTypeMap

Parameters

name

Example:

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

// Parsed values are runtime-validated and statically typed.
const health = parseSchema('health-response', { status: 'ok' })

console.log(health.status)

TName

value

Example:

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

// Parsed values are runtime-validated and statically typed.
const health = parseSchema('health-response', { status: 'ok' })

console.log(health.status)

unknown

Returns

SchemaTypeMap[TName]

Example

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

const health = parseSchema('health-response', { status: 'ok' })
console.log(health.status)

See

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