npm.io
0.14.0 • Published 2 years ago

@typeschema/ow

Licence
MIT
Version
0.14.0
Deps
1
Size
11 kB
Vulns
0
Weekly
0
Stars
451
TypeSchema

@typeschema/ow

License Bundle size npm downloads GitHub stars

Reusable adapter for Ow schemas
https://typeschema.com

import {initTRPC} from '@trpc/server';
import ow from 'ow';

import {wrap} from '@typeschema/ow';

const schema = ow.object.exactShape({name: ow.string});

const t = initTRPC.create();
const appRouter = t.router({
  hello: t.procedure
    .input(wrap(schema))
    .query(({input}) => `Hello, ${input.name}!`),
  //         ^? {name: string}
});

Use it directly or through @typeschema/main

Dependencies

  • ow: Required for inference and validation (^0.28.2)

API

Inference
  • Infer<TSchema>: Extracts the output type of a schema
  • InferIn<TSchema>: Extracts the input type of a schema
Validation
  • wrap(schema): Returns the wrapped schema with access to its operations
  • validate(schema, data): Returns the validated data or a list of validation issues
  • assert(schema, data): Returns the validated data or throws an AggregateError

Keywords