https://github.com/rumkin/pharmacy
Browser and Nodejs library for creating validators and sanitisers
https://github.com/rumkin/pharmacy
Last synced: about 1 year ago
JSON representation
Browser and Nodejs library for creating validators and sanitisers
- Host: GitHub
- URL: https://github.com/rumkin/pharmacy
- Owner: rumkin
- License: mit
- Created: 2015-11-04T10:22:00.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-07-02T09:53:20.000Z (almost 9 years ago)
- Last Synced: 2025-03-03T20:51:40.988Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/pharmacy
- Size: 32.2 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# Pharmacy
[](https://coveralls.io/r/rumkin/pharmacy?branch=master)
Pharmacy is a library for building validators and sanitizers. It is powered with
promises to make all operations fully asynchronous.
Pharmacy has several entities Store, Recipe, Rule, Field and Report. Store contains
complete validation and sanitizing recipes. Recipe contains rules. Rule
allow to validate or sanitize passed value. Field unites recipe and value
to validate and generate report.
## Basic example
Let's create number validator and try to validate different values.
```javascript
var pharmacy = require('pharmacy');
var store = new pharmacy.Store({
rules: {
// Check if value is number and it's acceptable.
isNumber(accept, value) {
return (typeof value === 'number') === accept;
}
}
});
// Validate number, expect a number
store
.validate(10, {isNumber: true})
.then(report => {
report.isValid(); // -> true
report.value; // -> 10
});
// Validate string, expect a number
store
.validate("10", {isNumber: true})
.then(report => {
report.isValid(); // -> false
report.value; // -> "10"
});
// Validate null, expect NOT a number
store
.validate(null, {isNumber: false})
.then(report => {
report.isValid(); // -> true
report.value; // -> null
});
```
## Complex example
Create independent rule and recipes. Add them to store and validate values using
recipe by name.
```javascript
var pharmacy = require('pharmacy');
var store = new pharmacy.Store();
// Create and add the rule.
var isBool = new pharmacy.Rule({
// Extend field object methods.
field(field) {
field.isBool = function () {
return typeof this.value === 'boolean';
};
},
// Sanitizer could convert values from string to acceptable value.
sanitize(accept, value) {
if (value === 'true') {
value = true;
} else if (value === 'false') {
value = false;
}
return value;
},
// Validate the value after sanitizing.
validate(accept, value, field) {
return field.isBool() === accept;
}
});
store.addRule('isBool', isBool);
// Create and add the recipe.
var recipe = new pharmacy.Recipe({
isBool: true
});
store.addRecipe('isTrue', recipe);
// Use recipe
store
.validate(true, 'isTrue')
.then(report => {
report.isValid(); // -> true
report.value; // -> true
});
// Use recipe
store
.validate(10, 'isTrue')
.then(report => {
report.isValid(); // -> false
report.value; // -> 10
});
```