diff options
Diffstat (limited to 'node_modules/vali-date/readme.md')
-rw-r--r-- | node_modules/vali-date/readme.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/node_modules/vali-date/readme.md b/node_modules/vali-date/readme.md new file mode 100644 index 000000000..b6943363d --- /dev/null +++ b/node_modules/vali-date/readme.md @@ -0,0 +1,44 @@ +# vali-date [![Build Status](https://travis-ci.org/SamVerschueren/vali-date.svg?branch=master)](https://travis-ci.org/SamVerschueren/vali-date) + +> Validate a date. + + +## Install + +``` +$ npm install --save vali-date +``` + + +## Usage + +```js +const validate = require('vali-date'); + +validate('foo'); +//=> false + +validate('2015-12-15T12:00:00Z'); +//=> true + +validate('2015-12-15T12:00:00+01:00'); +//=> true +``` + + +## API + +### validate(date) + +Returns a boolean indicating if the date provided is valid or not. + +#### date + +Type: `string` + +The date that should be validated. + + +## License + +MIT © [Sam Verschueren](http://github.com/SamVerschueren) |