typescript-schema-validator
v0.0.8
Published
Generate TS interfaces / types to json schema for validation in runtime
Downloads
9
Maintainers
Readme
typescript-schema-validator
A minimal interfaces / types schema generator for validation in runtime
Installation
npm i typescript-schema-validator --save-dev
or
yarn add typescript-schema-validator -D
Steps
- Create a schema file in ts
// schema.ts
export interface UserRequest {
name: string;
email: string;
}
- Add a script (package.json) to generate your schema file (Optional). You can generate schema file directly with this package's CLI
generate-schema
"scripts": {
"generate-ts-schema": "generate-schema"
}
- Run the generator from package.json scripts
yarn generate-ts-schema <schema fille> <new generated file name>
or directly from package command line
yarn generate-schema <schema fille> <new generated file name>
example
yarn generate-schema schema.ts generated-schema
- Use it in your express app to validate the incoming request
// @ts-ignore
import tsv from "typescript-schema-validator";
import express, { Express, Request, Response } from "express";
import schema from "./generated-schema";
const app: Express = express();
const port: number = 3000;
app.get("/", (req: Request, res: Response) => {
const validation = tsv(schema.UserRequest, { name: "Nusendra" });
res.send(validation);
});
app.listen(port, () => {
console.log(`⚡️[server]: Server is running at http://localhost:${port}`);
});