An open API service indexing awesome lists of open source software.

https://github.com/peakmoney/whitelister

Simple, basic filtering and validation tool for Node.js.
https://github.com/peakmoney/whitelister

javascript nodejs parameters utilities validation validation-library whitelist whitelist-validation whitelisting whitelisting-filter

Last synced: about 1 month ago
JSON representation

Simple, basic filtering and validation tool for Node.js.

Awesome Lists containing this project

README

        

# Whitelister

Simple, **dependency-free** filtering and validation tool for Node.js.

[![Build Status](https://travis-ci.org/SpireTeam/whitelister.svg?branch=master)](https://travis-ci.org/SpireTeam/whitelister)

## Quick Start

Using npm:

`npm i --save whitelister`

In Node.js
```js
const whitelister = require('whitelister');

const rules = {
q: 'string',
page: { type: 'integer', min: 1, default: 1 },
per_page: { type: 'integer', min: 1, max: 100, default: 20 },
};

const params = { q: 'hello' };

return whitelister(rules, params);
// => { page: 1, per_page: 20, q: 'hello' };
```

## Documentation

You can find the full documentation on the website: [https://spireteam.github.io/whitelister/](https://spireteam.github.io/whitelister/)

## License

MIT

## Changelog

### v0.0.5
#### Oct. 25, 2017
* Ignore non-required properties with `undefined` values
* Treat external errors differently than internal errors

### v0.0.4
#### Oct. 16, 2017
* Ensure that `type` is treated like other `attributes`