getRegExp()function

getRegExp(pattern: NamedRegExp<T>, flags?: string): T extends NamedRegExpData ? NamedRegExp<T> : RegExp
getRegExp(pattern: PossibleRegExp, flags?: string): T extends NamedRegExpData ? NamedRegExp<T> : RegExp
ParamType
patternNamedRegExp<T>
The regular expression or string source to convert. required
flagsstring
The flags to use when creating a RegExp from a string source.
patternPossibleRegExp
Things that can be converted to a regular expression. required
flagsstring
Return
T extends NamedRegExpData ? NamedRegExp<T> : RegExp
The corresponding RegExp instance.
T extends NamedRegExpData ? NamedRegExp<T> : RegExp

Convert a possible regular expression into a RegExp instance.

  • If pattern is a string a new RegExp is created from it, otherwise it is returned as-is.

Examples

getRegExp("abc", "i"); // /abc/i