joi-decorator
v1.1.2
Published
Decorator based interface for Joi
Downloads
392
Maintainers
Readme
joi-decorator
Decorator based interface for Joi.
Installation
npm install joi-decorator reflect-metadata
The basics
First you need to declare an entity:
import { mustBe, a } from "joi-decorator";
export class User {
@mustBe(a.string().alphanum().min(3).max(30).required())
username: string
@mustBe(a.string().regex(/^[a-zA-Z0-9]{3,30}$/))
password: string
@mustBe([a.string(), a.number()])
accessToken: string | number
@mustBe(a.number().integer().min(1900).max(2013))
birthyear: number
@mustBe(a.string().email())
email: string
constructor(
username: string,
password: string,
access_token: string | number,
birthyear: number,
email: string
) {
this.username = username
this.password = password
this.accessToken = accessToken
this.birthyear = birthyear
this.email = email
}
}
Then you can validate the entity instances:
Example 1: Valid entity
import { validate } from "joi-decorator";
import { User } from "./entities/user";
const userInput = new User(
"root",
"secret",
"token",
1989,
"[email protected]"
);
const userValid = validate(userInput);
License
Inspired by zafiro-validators.
Copyright (c) Jean-Baptiste Pionnier