is-valid-year

Returns true if a year is valid based on a given year, range of years, sequences of years, or any mixture of these.

Install

Install with npm

$ npm i is-valid-year --save

Usage

Supports years as numbers or strings:

var isValidYear = require('is-valid-year');

Acceptable formats

Pass an array or list or years or year ranges (years must increase from left to right).

• The first argument is the year to validate
• Everything else is a valid year to test against
• Year ranges must always be a string separated by -, as in 2001-2005
• Non-ranges (sequential or otherwise) may be separated by , or | when passed as a string, or as must be passed as individual array elements.

All of the following should work:

isValidYear(2011, 2015);
//=> false
isValidYear(2015, 2015);
//=> true

isValidYear(2015, [1999, 2000, 2001]);
//=> false
isValidYear(2001, [1999, 2000, 2001]);
//=> true

isValidYear(2009, '2010-2015');
//=> false
isValidYear(2010, '2010-2015');
//=> true

isValidYear(2008, '2009,2010-2015');
//=> false
isValidYear(2009, '2009,2010-2015');
//=> true

isValidYear(2011, [1997, '1999-2009', 2010]);
//=> false
isValidYear(2010, [1997, '1999-2009', 2010]);
//=> true

Related projects

• expand-range: Fast, bash-like range expansion. Expand a range of numbers or letters, uppercase or lowercase. See… more
• fill-range: Fill in a range of numbers or letters, optionally passing an increment or multiplier to… more
• repeat-element: Create an array by repeating the given value n times.
• repeat-string: Repeat the given string n times. Fastest implementation for repeating a string.
• to-regex-range: Returns a regex-compatible range from two numbers, min and max. Useful for creating regular expressions… more

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.

This file was generated by verb-cli on August 07, 2015.