Validar Decorators

!npm bundle size

Decorators for the validar package.

Install

``js
npm install validar-decorators
`

As decorators are a part of future ECMAScript standard they can only be used with transpilers such as Babel or Typescript.

This package is written in typescript.

Example

`js
// person.ts
import { isValid, validateClass, validateClassAsync } from 'validar-decorators'
import { validation } from 'validar'

class Person {
// @isValid decorator accepts validation
@isValid(validation(() => true))
public name: string

// or array of validations
@isValid([validation(() => true),validation(() => true)])
public lastName: string

@isValid({
address: {
street: validation(() => true),
appartmentNumber: validation(() => true),
},
city: validation(() => true),
country: validation(() => false),
})
public location: Location
}
`

`js
// application.ts
const person = new Person()

person.name = 'Sam'
person.lastName = 'Fisher'
person.location = {
address: {
street: 'Beverly Hills',
appartmentNumber: 33,
city: 'LA',
country: 'USA',
},
}

// actual validation step
const result = validateClass(person)

// if you have async tests
validateClassAsync(person).then(result => {
console.log(result)
})
`

$3

You can also validate static properties.

`js
class Person {
static totalCount: number = 3000
static males: number = 1500
static females: number = 1500
}

const result = validateClass(Person)

// if you have async tests
validateClassAsync(person).then(result => {
console.log(result)
})
`

$3

Subclasses inherit validation checks from the parent class, but they can also override them.

`js
class Person {
@isValid(validation(() => true))
name: string = 'Sam'

@isValid(validation(() => true))
lastName: string
}

class Pilot extends Person {
// override validation
@isValid(validation(() => false))
name: string

// override validation
@isValid(validation(() => false))
lastName: string

@isValid(validation(() => false))
nick: string
}

const pilot = new Pilot()
pilot.name = 'Pete'
pilot.lastName = 'Mitchell'
pilot.nick = 'Maveric'

// actual validation step
const result = validateClass(pilot)
`

For more info about validar package check out the documentation

$3

Validar Decorators` is written in TypeScript, auto generated API docs are available.

##### Author

- Ivan Vlatković

##### License

This project is licensed under the MIT License - see the LICENSE file for details