to-regex-range

Pass two numbers, get a regex-compatible source string for matching ranges. Validated against more than 2.78 million test assertions.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

1$ npm install --save to-regex-range

1const toRegexRange = require('to-regex-range');
2const regex = new RegExp(toRegexRange('15', '95'));

Usage

Add this library to your javascript application with the following line of code

1const toRegexRange = require('to-regex-range');

The main export is a function that takes two integers: the min value and max value (formatted as strings or numbers).

1const source = toRegexRange('15', '95');
2//=> 1[5-9]|[2-8][0-9]|9[0-5]
3
4const regex = new RegExp(`^${source}$`);
5console.log(regex.test('14')); //=> false
6console.log(regex.test('50')); //=> true
7console.log(regex.test('94')); //=> true
8console.log(regex.test('96')); //=> false

Options

options.capture

Type: boolean

Deafault: undefined

Wrap the returned value in parentheses when there is more than one regex condition. Useful when you're dynamically generating ranges.

1console.log(toRegexRange('-10', '10'));
2//=> -[1-9]|-?10|[0-9]
3
4console.log(toRegexRange('-10', '10', { capture: true }));
5//=> (-[1-9]|-?10|[0-9])

options.shorthand

Type: boolean

Deafault: undefined

Use the regex shorthand for [0-9]:

1console.log(toRegexRange('0', '999999'));
2//=> [0-9]|[1-9][0-9]{1,5}
3
4console.log(toRegexRange('0', '999999', { shorthand: true }));
5//=> \d|[1-9]\d{1,5}

options.relaxZeros

Type: boolean

Default: true

This option relaxes matching for leading zeros when when ranges are zero-padded.

1const source = toRegexRange('-0010', '0010');
2const regex = new RegExp(`^${source}$`);
3console.log(regex.test('-10')); //=> true
4console.log(regex.test('-010')); //=> true
5console.log(regex.test('-0010')); //=> true
6console.log(regex.test('10')); //=> true
7console.log(regex.test('010')); //=> true
8console.log(regex.test('0010')); //=> true

When relaxZeros is false, matching is strict:

1const source = toRegexRange('-0010', '0010', { relaxZeros: false });
2const regex = new RegExp(`^${source}$`);
3console.log(regex.test('-10')); //=> false
4console.log(regex.test('-010')); //=> false
5console.log(regex.test('-0010')); //=> true
6console.log(regex.test('10')); //=> false
7console.log(regex.test('010')); //=> false
8console.log(regex.test('0010')); //=> true

Examples

Heads up!

Order of arguments

When the min is larger than the max, values will be flipped to create a valid range:

1toRegexRange('51', '29');

Is effectively flipped to:

1toRegexRange('29', '51');
2//=> 29|[3-4][0-9]|5[0-1]

Steps / increments

This library does not support steps (increments). A pr to add support would be welcome.

History

v2.0.0 - 2017-04-21

New features

Adds support for zero-padding!

v1.0.0

Optimizations

Repeating ranges are now grouped using quantifiers. rocessing time is roughly the same, but the generated regex is much smaller, which should result in faster matching.

Attribution

Inspired by the python library range-regex.

About

1$ npm install && npm test

1$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

• expand-range: Fast, bash-like range expansion. Expand a range of numbers or letters, uppercase or lowercase. Used… more | homepage
• fill-range: Fill in a range of numbers or letters, optionally passing an increment or step to… more | homepage
• micromatch: Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | homepage
• repeat-element: Create an array by repeating the given value n times. | homepage
• repeat-string: Repeat the given string n times. Fastest implementation for repeating a string. | homepage

Contributors

Author

Jon Schlinkert

• GitHub Profile
• Twitter Profile
• LinkedIn Profile

Please consider supporting me on Patreon, or start your own Patreon page!

License

Copyright © 2019, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.8.0, on April 07, 2019.