Goals

Installation

# npmnpm install --save reregexp# or yarnyarn add reregexp

Usage

// Commonjs moduleconstReRegExp=require('reregexp').default;// ESM module// since v1.6.1importReRegExpfrom'reregexp';// before v1.6.1importrefrom'reregexp';constReRegExp=re.default;// For the first parameter of the constructor// You can use a regex literal or a RegExp string// if you need use some features that are not well supported by all browsers// such as a named group, you should always choose a RegExp string// Example 1:  use group referenceconstr1=newReRegExp(/([a-z0-9]{3})_\1/);r1.build();// => 'a2z_a2z' '13d_13d'// Example 2:  use named groupconstr2=newReRegExp(/(?<named>\w{1,2})_\1_\k<named>/);r2.build();// => 'b5_b5_b5' '9_9_9'// Example 3: use named group and with `namedGroupConf` config// it will use the string in the config insteadof the string that will generated by the named group// of course, it will trigger an error if the string in config not match the rule of named group.constr3=newReRegExp('/(a)\\1(?<named>b)\\k<named>(?<override>\\w+)/',{namedGroupConf:{override:['cc','dd'],},});r3.build();// => "aabbcc" "aabbdd"// Example 4: use a character setconstr4=newReRegExp(/[^\w\W]+/);r4.build();// will throw error, because the [^\w\W] will match nothing.// Example 5: also a character set with negative operatorconstr5=newReRegExp(/[^a-zA-Z0-9_\W]/);r5.build();// will throw error, this is the same as [^\w\W]// Example 6: with the `i` flag, ignore the case.constr6=newReRegExp(/[a-z]{3}/i);r6.build();// => 'bZD' 'Poe'// Example 7: with the `u` flag, e.g. make some chinese characters.constr7=newReRegExp('/[\\u{4e00}-\\u{9fcc}]{5,10}/u');r7.build();// => '偤豄酌菵呑', '孜垟与醽奚衜踆猠'// Example 8: set a global `maxRepeat` when use quantifier such as '*' and '+'.ReRegExp.maxRepeat=10;constr8=newReRegExp(/a*/);r8.build();// => 'aaaaaaa', 'a' will repeated at most 10 times.// Example 9: use a `maxRepeat` in constructor config, it will override `maxRepeat` of the global.constr9=newReRegExp(/a*/,{maxRepeat:20,});r9.build();// => 'aaaaaaaaaaaaaa', 'a' will repeated at most 20 times// Example 10: use a `extractSetAverage` config for character sets.constr10=newReRegExp(/[\Wa-z]/,{// \W will extract as all the characters match \W, a-z now doesn't have the same chance as \WextractSetAverage:true,});// Example 11: use a `capture` config if cared about the capture dataconstr11=newReRegExp(/(aa?)b(?<named>\w)/),{capture:true,// if you cared about the group capture data, set the `capture` config true});r11.build();// => 'abc'console.log(r11.$1);// => 'a'console.log(r11.$2);// => 'c'console.log(r11.groups);// => {named: 'c'}// Example 12: use the unicode property class by setting the `UPCFactory`ReRegExp.UPCFactory=(data:UPCData)=>{/*  UPCData: {    negate: boolean; // if the symbol is 'P'    short: boolean; // take '\pL' as a short for '\p{Letter}'    key?: string; // if has a unicode property name, such as `Script`    value: string; // unicode property value, binary or non-binary  }  */return{generate(){return'x';// return an object that has a `generate` method.}}};constr12=newReRegExp('/\\p{Lu}/u');console.log(r12.build());// => 'x', should handle in the `UPCFactory` method.

Config

// The meaning of the config fields can seen in the examples.{maxRepeat?:number; namedGroupConf?:{[index:string]:string[]|boolean;}; extractSetAverage?:boolean; capture?:boolean;}

Supported flags

Methods

{rule:'',context:'',flags:[],lastRule:'',queues:[],}

Build precautions,do not use any regexp anchors.

Special cases

Questions & Bugs?

License