to-regex
Generate a regex from a string or array of strings.
Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.
(TOC generated by verb using markdown-toc)
Install
Install with npm:
Usage
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.
options.negate
Type: Boolean
Default: undefined
Create a regex that will match everything except the given pattern.
options.nocase
Type: Boolean
Default: undefined
Adds the i
flag, to enable case-insensitive matching.
Alternatively 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.
options.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
options.safe
Type: Boolean
Default: undefined
Check the generated regular expression with safe-regex and throw an error if the regex is potentially unsafe.
Examples
About
Related projects
You might also be interested in these projects:
path-regex: Regular expression for matching the parts of a file path. | homepage
to-regex-range: Pass two numbers, get a regex-compatible source string for matching ranges. Validated against more than… more | homepage
Author
Jon Schlinkert
License
Copyright © 2018, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on February 24, 2018.
Last updated