handcuffs

Handcuffs

Async validation library for node and browser.

Installation

Install using npm or yarn:

npm install handcuffs
# or
yarn add handcuffs

Usage

Basic usage example:

import { validate } from 'handcuffs'

const data = {
  name: 'Jack',
  wife: {
    name: 'Susan'
  }
}

const rules = {
  name: 'required|string',
  'wife.age': 'required|number',
  pets: 'required|array',
  'pets.*.type': 'required|string'
}


async function start() {
  const validationResult = await validate(data, rules)

  if (!validationResult.valid) {
    console.log(validationResult.errors)
  }
}

start()

Rules

accepted

{ rules: 'accepted' }

The field under validation must be 'yes', 'on', 1, or true.

alpha

{ name: 'alpha' }

The field under validation must be entirely alphabetic characters.

alphaNum

{ password: 'alphaNum' }

The field under validation must be entirely alpha-numeric characters.

alphaNumDash

{ url: 'alphaNumDash' }

The field under validation may have alpha-numeric characters, as well as dashes and underscores.

array

{ permissions: 'array' }

The field under validation must be an array.

between

{ guests: 'between:1,3' }

The field under validation must have a size between the given min and max values.

boolean

{ isVisible: 'boolean' }

The field under validation must be a boolean. Accepted input values are true and false.

max

{ password: 'max:10' }

The field under validation must be less than or equal to the given max value.

min

{ password: 'min:6' }

The field under validation must be greater than or equal to the given min value.

numeric

{ age: 'numeric' }

The field under validation must be numeric.

required

{ name: 'required' }

The field under validation must be present in the input data and not empty.

string

{ name: 'string' }

The field under validation must be a string.

License

MIT