njr

named-js-regexp

Extends JavaScript RegExp with named groups, backreferences and replacement.

Showing:

Popularity

Downloads/wk

12.4K

GitHub Stars

19

Maintenance

Last Commit

3yrs ago

Contributors

1

Package

Dependencies

0

Size (min+gzip)

1.1KB

License

MIT

Type Definitions

Built-In

Tree-Shakeable

No?

Categories

Readme

named-js-regexp

Extends JavaScript RegExp with named groups, backreferences and replacement. All are converted to normal JavaScript RegExp so you will get the same speed except for initial parsing, which can also be eliminated with cache enabled.

Syntax

Named group: (?<name>expression) or (:<name>expression)
Named backreference: \k<name>
Named group in replacement text: ${name}

Install

npm install named-js-regexp --save

Using with regexp.execGroups

var namedRegexp = require("named-js-regexp");

var re=namedRegexp("(?<hours>\\d\\d?):(?<minutes>\\d\\d?)(:(?<seconds>\\d\\d?))?"); 
// or with regexp literal... NOTE: you must use (:<name>) 
var re=namedRegexp(/(:<hours>\d\d?):(:<minutes>\d\d?)(:(:<seconds>\d\d?))?/);

re.execGroups("1:2:33");    // => { hours:"1", minutes:"2", seconds:"33" }
re.execGroups("1");         // => null

Using with regexp.exec

var re=namedRegexp("(?<hours>\\d\\d?):(?<minutes>\\d\\d?)(:(?<seconds>\\d\\d?))?");
var result=re.exec("1:2");
result.groups();            // => { hours:"1", minutes:"2", seconds:undefined }
result.group("minutes");    // => "2"
result.group("seconds");    // => undefined

Using named backreferences

var re=namedRegexp("(<(?<elem>\\w+)>).*<\/\\k<elem>>");
var result=re.exec("<div>hi</div>");
result.groups();            // => { elem: "div" }

Using named replacement

var re = namedRegexp("(?<h>\\d+):(?<m>\\d+):(?<s>\\d+)");
re.replace('1:23:44', '${h}hour(s) ${m}minute(s) ${s}second(s)');
// => 1hour(s) 23minute(s) 44second(s)
re.replace('1:23:44', function () {
    var g = this.groups();
    return g.h + 'hour' + (g.h > 1 ? 's ' : ' ')+ g.m + 'minute' + (g.m > 1 ? 's ' : ' ')+ g.s + 'second' + (g.s > 1 ? 's' : '');
});
// => 1hour 23minutes 44seconds

Using with regexp.groupsIndices

var re = namedRegexp("(?<hours>\\d\\d?):(?<minutes>\\d\\d?)(:(?<seconds>\\d\\d?))?");
var matches = "1:2".match(re);
matches[re.groupsIndices["hours"]];     // => "1"
matches[re.groupsIndices["seconds"]];   // => undefined

Handling group name duplication

var re = namedRegexp("(?<digit>((?<a>\\d):(?<b>\\d)))|(?<char>((?<a>\\w):(?<b>\\w)))");
re.groupsIndices;    // => { digit: 1, a: [ 3, 7 ], b: [ 4, 8 ], char: 5 }

var r = re.exec("a:b");
r.groups();          // => { a: "a", b: "b", digit: undefined, char: "a:b" }
r.groups(true);      // => { a: [undefined, "a"], b: [undefined, "b"], digit: undefined, char: "a:b" }
r = re.exec("1:2");
r.groups();          // => { a: "1", b: "2", digit: "1:2", char: undefined }
r.groups(true);      // => { a: ["1", undefined], b: ["2", undefined], digit: "1:2", char: undefined }

Using with successive matches

var re = namedRegexp("(?<x>\\d)(?<y>\\w)", "g");
var r = re.exec("1a2b");
r.groups();              // => { x: '1', y: 'a' }
r = re.exec("1a2b");
r.groups();              // => { x: '2', y: 'b' }
r = re.exec("1a2b");     // => null

API

var namedRegexp = require("named-js-regexp");
regexp=namedRegexp(value:string|RegExp|boolean, flags?:string)
Returns normal JavaScript RegExp object with some additional properties. Parameter value can be string expression or RegExp object. For latest you must use (:<name>expression) syntax and flags parameter is ignored.
Set value parameter to true to enable caching or set to false to clear and disable cache.

regexp

regexp.exec(expression:string)
Performs search for the matches and returns null if no match was found or matched (Array) result.

regexp.execGroups(expression:string, all?:boolean)
Performs search for the matches and returns null if no match was found or name/value dictionary, where name is group name and value is matched value. If same group name was defined multiple times and parameter all is false (default) then first (from left to right) not undefined value is returned. If parameter all is true then returned value is array of all matched values.

regexp.replace(text:string, replacement:string|function)
Works as String.prototype.replace. If parameter replacement is string you can also use named replace like ${name} instead of $1. If replacement is function it receives same parameters as String.prototype.replace callback, but this is set to matched object, similar to one returned by exec.

regexp.groupsIndices
Returns name/value mapper where name is group name and value is index that can be used to access matched value by index. If same group name was defined multiple times then value is array of all matched indices ordered from left to right as defined in regular expression.

matched (returned by regexp.exec)

matched.groups(all?:boolean)
Returns name/value dictionary, where name is group name and value is matched value. Check regexp.execGroups for info about parameter all.

matched.group(name:string, all?:boolean)
Returns named group value or undefined if named group was not found. Check regexp.execGroups for info about parameter all.

NOTES

  • Group name should start with '_$a-zA-Z' and can contain only '_$a-zA-Z0-9'.
  • Named backreference should refer to already defined named group, otherwise error is thrown.
  • Named backreference and named replacement should not refer to duplicated named group, otherwise error is thrown.

LICENCE

MIT

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial