Skip to main content

@rtorcato/api-validation v1.0.0

Functions​

formatZodError()​

formatZodError(error, options?): string

Defined in: index.ts:10

Format a ZodError into a single human-readable string.

Parameters​

error​

ZodError

options?​

ErrorMessageOptions = defaultErrorOptions

Returns​

string


validate()​

validate<T>(schema, data): output<T>

Defined in: index.ts:24

Parse data with schema, returning the typed result.

Throws a BadRequestError (from @rtorcato/api-errors) carrying a formatted message when validation fails, so it slots straight into the error-handler middleware in api-errors-express / api-errors-hono.

Type Parameters​

T​

T extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

Parameters​

schema​

T

data​

unknown

Returns​

output<T>