API Reference

Schema Validation APIs

validate${schemaName}

function validate${schemaName}(data: unknown): ZodIssue[] | undefined

Validates data against the schema. Returns:

• undefined if validation passes
• Array of ZodIssue objects if validation fails

Example:

const issues = validateUser(data)
if (issues) {
  // handle validation errors
}

is${schemaName}

function is${schemaName}(data: unknown): data is ${schemaName}

Type predicate that checks if data matches the schema. Returns true if valid.

Example:

if (isUser(data)) {
  // data is now typed as User
}

assert${schemaName}

function assert${schemaName}(data: unknown): asserts data is ${schemaName}

Validates data and throws validation issues if invalid. If it returns, data is guaranteed to match the schema type.

Example:

try {
  assertUser(data)
  // data is now typed as User
} catch (issues) {
  // handle validation errors
}

WARNING

The current implementation of is${schemaName} and assert${schemaName} APIs cannot provide full type hinting functionality as the TypeScript plugin is still under development.

Progress can be tracked in these issues:

• vscode extension adding typescript plugin automatically #5
• typescript plugin to provide type definition of generated validation schema #6

These features will be implemented in future releases. The current version still performs runtime validation, but lacks static type hints.