Regular Expression Constructor (NodeJS)
RegularExpressionConstructor.NodeJS
Release | Latest ( |
Pre ( |
---|---|---|
GitHub |
||
NPM |
📝 Description
A NodeJS module to help for constructing regular expression.
📚 Documentation
Getting Started
Install
- NodeJS >= v14.15.0
- NPM >= v6.14.8
npm install @hugoalh/regular-expression-constructor
Use In CommonJS
const regularExpressionConstructor = require("@hugoalh/regular-expression-constructor");
Use In ModuleJS
import regularExpressionConstructor from "@hugoalh/regular-expression-constructor";
API
Function
regularExpressionConstructor(
pattern: string,
flags?: (RegularExpressionConstructorFlags|string) = {}
): RegExp
interface RegularExpressionConstructorFlags {
boundary?: boolean = false,// Add word boundary assertions at the start and end of the pattern.
caseInsensitive?: boolean = false,
exactly?: boolean = false,// Add begin and end line assertions at the start and end of the pattern.
global?: boolean = false,
multipleLine?: boolean = false,
sticky?: boolean = false
}
Example
regularExpressionConstructor("fo+", "bi");
//=> /\b(?:fo+)\b/iu
regularExpressionConstructor("fo+", "eg");
//=> /^(?:fo+)$/gu