regexp-tpl

regexp-tpl

regexp-tpl allows you to create templated regular expressions.

Installation

First install regexp-tpl in you project:

npm install --save regexp-tpl

Getting started

Then, use it:

const regexpTpl = require('regexp-tpl');
const assert = require('assert');

const fruits = [{
  name: 'orange',
  count: 2,
  colors: ['orange'],
}, {
	name: 'banana',
  count: 0,
  colors: ['yellow', 'white'],
}, {
	name: 'kiwi',
  count: 8,
  colors: ['brown', 'green'],
}];

assert(regexpTpl(fruits, 'My car is {colors.#}!').test('My car is brown!'));
assert(!regexpTpl(fruits, 'My car is {colors.#}!').test('My car is blue!'));

Note that regexp-tpl template values are evaluated with miniquery's syntax.

## API

### regExp:RegExp regexpTpl(objs:Array, regExpTemplate:String, regExpflags:String, tplRegExp:RegExp) Return a RegExp instance made with the given regExpTemplate and regExplags filled with the values picked up in the given objs. An optionnal tplRegExp value can be provided for custom template syntax.

Contribute

Feel free to submit us your improvements. To do so, you must accept to publish your code under the MIT license.

To start contributing, first run the following to setup the development environment:

git clone [e-mail]:SimpliField/regexp-tpl.git
cd regexp-tpl
npm install

Then, run the tests:

npm test

Stats