@typeschema/effect
TypeScript icon, indicating that this package has built-in type declarations

0.13.4 • Public • Published

TypeSchema

@typeschema/effect

License Bundle size npm downloads GitHub stars

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

import * as S from '@effect/schema/Schema';
import {initTRPC} from '@trpc/server';

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

const schema = S.struct({name: S.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

  • @effect/schema: Required for inference, validation, and serialization (^0.63.2)
  • effect: Required for inference and validation (^2.4.1)

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

Serialization

  • toJSONSchema(schema): Converts the schema into the equivalent JSON schema

Package Sidebar

Install

npm i @typeschema/effect

Weekly Downloads

17

Version

0.13.4

License

MIT

Unpacked Size

14.5 kB

Total Files

7

Last publish

Collaborators

  • decs