npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

validar-decorators

v1.0.9

Published

Decorators for validar package

Downloads

10

Readme

Validar Decorators

CircleCI Codecov npm bundle size NPM

Decorators for the validar package.

Install

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

// 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
}
// 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)
})

Static properties

You can also validate static properties.

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)
})

Working with subclasses

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

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

API docs

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