Package Exports
- to-regex
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (to-regex) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
to-regex 
Generate a regex from a string or array of strings.
Table of Contents
(TOC generated by verb using markdown-toc)
Install
Install with npm:
$ npm install --save to-regexUsage
var toRegex = require('to-regex');
console.log(toRegex('foo'));
//=> /^(?:foo)$/
console.log(toRegex('foo', {negate: true}));
//=> /^(?:(?:(?!^(?:foo)$).)*)$/
console.log(toRegex('foo', {contains: true}));
//=> /(?:foo)/
console.log(toRegex(['foo', 'bar'], {negate: true}));
//=> /^(?:(?:(?!^(?:(?:foo)|(?:bar))$).)*)$/
console.log(toRegex(['foo', 'bar'], {negate: true, contains: true}));
//=> /^(?:(?:(?!(?:(?:foo)|(?:bar))).)*)$/Options
options.contains
Type: Boolean
Default: undefined
Generate a regex that will match any string that contains the given pattern. By default, regex is strict will only return true for exact matches.
var toRegex = require('to-regex');
console.log(toRegex('foo', {contains: true}));
//=> /(?:foo)/options.negate
Type: Boolean
Default: undefined
Create a regex that will match everything except the given pattern.
var toRegex = require('to-regex');
console.log(toRegex('foo', {negate: true}));
//=> /^(?:(?:(?!^(?:foo)$).)*)$/options.nocase
Type: Boolean
Default: undefined
Adds the i flag, to enable case-insensitive matching.
var toRegex = require('to-regex');
console.log(toRegex('foo', {nocase: true}));
//=> /^(?:foo)$/iAlternatively you can pass the flags you want directly on options.flags.
options.flags
Type: String
Default: undefined
Define the flags you want to use on the generated regex.
var toRegex = require('to-regex');
console.log(toRegex('foo', {flags: 'gm'}));
//=> /^(?:foo)$/gm
console.log(toRegex('foo', {flags: 'gmi', nocase: true})); //<= handles redundancy
//=> /^(?:foo)$/gmioptions.cache
Type: Boolean
Default: true
Generated regex is cached based on the provided string and options. As a result, runtime compilation only happens once per pattern (as long as options are also the same), which can result in dramatic speed improvements.
This also helps with debugging, since adding options and pattern are added to the generated regex.
Disable caching
toRegex('foo', {cache: false});About
Related projects
- has-glob: Returns
trueif an array has a glob pattern. | homepage - is-glob: Returns
trueif the given string looks like a glob pattern or an extglob pattern… more | homepage - path-regex: Regular expression for matching the parts of a file path. | homepage
- to-regex-range: Returns a regex-compatible range from two numbers, min and max, with 855,412 generated unit tests… more | homepage
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Building docs
(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)
To generate the readme and API documentation with verb:
$ npm install -g verb verb-generate-readme && verbRunning tests
Install dev dependencies:
$ npm install -d && npm testAuthor
Jon Schlinkert
License
Copyright © 2016, Jon Schlinkert. Released under the MIT license.
This file was generated by verb-generate-readme, v0.1.31, on October 06, 2016.