policeman

policeman

Lightweight yet powerful schema validator

---

API Docs | Examples

---

• Validate objects based on provided schemas
• Build with mappet

Installation (npm)

npm i -S policeman

Built-in validators

All built-in validator are curried.

isRequired(() => message, value)

Validates presence. Fails on null, empty string or undefined.

isMinLength(min, () => message, value)

Passed value must be a string longer or with length equal to min.

isMaxLength(max, () => message, value)

Passed value must be a string shorther or with length equal to max.

isEqualLength(equal, () => message, value)

Passed value must be a string shorther or with length equal to max.

isEmail(() => message, value)

Passed value must be a valid email. It's a simple check, if you need more complex solution use isMatching or isPassing.

isMatching(regexp, () => message, value)

Passed value must pass regexp.

isPassing(predicate, () => message, value)

Passed predicate answers on "Is value valid?". When predicate returns true validator passes, when predicate returns false error message is returned.

It makes policeman compatible with all available validators i.e. validator.

import validator from "validator";
import { isPassing } from "policeman";

const isCreditCard = isPassing(validator.isCreditCard, () => "is invalid credit card");
const isUUID4 = isPassing(value => validator.isUUID(value, 4), () => "is invalid UUID v4");
const isFTP = isPassing(value => validator.isURL(value, { protocols: ["ftp"] }, () => "is invalid FTP address");

See tests for more examples.

Examples

TODO

See tests for more examples.

Roadmap

• Improve importing validators
• Maybe (monad) error?

Changelog

0.2.0

• Errors format corresponds to validation format (more)
• Direct validators import i.e. import { isEmail } from "policeman"
• Rename maxLength and minLength to isMaxLength and isMinLength
• Add isEqualLength validator