Interface: Regex<pattern, ctx>
Defined in: node_modules/.pnpm/[email protected]/node_modules/arkregex/out/regex.d.ts:14
Extends
RegExp
Type Parameters
pattern
pattern extends string = string
ctx
ctx extends RegexContext = RegexContext
Properties
arkInferred
" arkInferred": pattern;Defined in: node_modules/.pnpm/[email protected]/node_modules/arkregex/out/regex.d.ts:15
dotAll
readonly dotAll: boolean;Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2018.regexp.d.ts:34
Returns a Boolean value indicating the state of the dotAll flag (s) used with a regular expression. Default is false. Read-only.
Inherited from
RegExp.dotAll
flags
flags: ctx["flags"] extends
| ""
| "gu"
| "u"
| "i"
| "v"
| "div"
| "s"
| "d"
| "g"
| "m"
| "y"
| "uy"
| "vy"
| "sy"
| "su"
| "suy"
| "sv"
| "svy"
| "my"
| "mu"
| "muy"
| "mv"
| "mvy"
| "ms"
| "msy"
| "msu"
| "msuy"
| "msv"
| "msvy"
| "iy"
| "iu"
| "iuy"
| "iv"
| "ivy"
| "is"
| "isy"
| "isu"
| "isuy"
| "isv"
| "isvy"
| "im"
| "imy"
| "imu"
| "imuy"
| "imv"
| "imvy"
| "ims"
| "imsy"
| "imsu"
| "imsuy"
| "imsv"
| "imsvy"
| "gy"
| "guy"
| "gv"
| "gvy"
| "gs"
| "gsy"
| "gsu"
| "gsuy"
| "gsv"
| "gsvy"
| "gm"
| "gmy"
| "gmu"
| "gmuy"
| "gmv"
| "gmvy"
| "gms"
| "gmsy"
| "gmsu"
| "gmsuy"
| "gmsv"
| "gmsvy"
| "gi"
| "giy"
| "giu"
| "giuy"
| "giv"
| "givy"
| "gis"
| "gisy"
| "gisu"
| "gisuy"
| "gisv"
| "gisvy"
| "gim"
| "gimy"
| "gimu"
| "gimuy"
| "gimv"
| "gimvy"
| "gims"
| "gimsy"
| "gimsu"
| "gimsuy"
| "gimsv"
| "gimsvy"
| "dy"
| "du"
| "duy"
| "dv"
| "dvy"
| "ds"
| "dsy"
| "dsu"
| "dsuy"
| "dsv"
| "dsvy"
| "dm"
| "dmy"
| "dmu"
| "dmuy"
| "dmv"
| "dmvy"
| "dms"
| "dmsy"
| "dmsu"
| "dmsuy"
| "dmsv"
| "dmsvy"
| "di"
| "diy"
| "diu"
| "diuy"
| "divy"
| "dis"
| "disy"
| "disu"
| "disuy"
| "disv"
| "disvy"
| "dim"
| "dimy"
| "dimu"
| "dimuy"
| "dimv"
| "dimvy"
| "dims"
| "dimsy"
| "dimsu"
| "dimsuy"
| "dimsv"
| "dimsvy"
| "dg"
| "dgy"
| "dgu"
| "dguy"
| "dgv"
| "dgvy"
| "dgs"
| "dgsy"
| "dgsu"
| "dgsuy"
| "dgsv"
| "dgsvy"
| "dgm"
| "dgmy"
| "dgmu"
| "dgmuy"
| "dgmv"
| "dgmvy"
| "dgms"
| "dgmsy"
| "dgmsu"
| "dgmsuy"
| "dgmsv"
| "dgmsvy"
| "dgi"
| "dgiy"
| "dgiu"
| "dgiuy"
| "dgiv"
| "dgivy"
| "dgis"
| "dgisy"
| "dgisu"
| "dgisuy"
| "dgisv"
| "dgisvy"
| "dgim"
| "dgimy"
| "dgimu"
| "dgimuy"
| "dgimv"
| "dgimvy"
| "dgims"
| "dgimsy"
| "dgimsu"
| "dgimsuy"
| "dgimsv"
| "dgimsvy" ? any[any] : "";Defined in: node_modules/.pnpm/[email protected]/node_modules/arkregex/out/regex.d.ts:23
Returns a string indicating the flags of the regular expression in question. This field is read-only. The characters in this string are sequenced and concatenated in the following order:
- "g" for global
- "i" for ignoreCase
- "m" for multiline
- "u" for unicode
- "y" for sticky
If no flags are set, the value is the empty string.
Overrides
RegExp.flags
global
readonly global: boolean;Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1008
Returns a Boolean value indicating the state of the global flag (g) used with a regular expression. Default is false. Read-only.
Inherited from
RegExp.global
hasIndices
readonly hasIndices: boolean;Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.regexp.d.ts:36
Returns a Boolean value indicating the state of the hasIndices flag (d) used with a regular expression. Default is false. Read-only.
Inherited from
RegExp.hasIndices
ignoreCase
readonly ignoreCase: boolean;Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1011
Returns a Boolean value indicating the state of the ignoreCase flag (i) used with a regular expression. Default is false. Read-only.
Inherited from
RegExp.ignoreCase
infer
infer: pattern;Defined in: node_modules/.pnpm/[email protected]/node_modules/arkregex/out/regex.d.ts:16
inferCaptures
inferCaptures: ctx["captures"] extends IndexedCaptures ? any[any] : [];Defined in: node_modules/.pnpm/[email protected]/node_modules/arkregex/out/regex.d.ts:17
inferExecArray
inferExecArray: RegexExecArray<[pattern, ...(ctx["captures"] extends IndexedCaptures ? any[any] : [])[]], ctx["names"] extends NamedCaptures ? any[any] : object, ctx["flags"] extends
| ""
| "gu"
| "u"
| "i"
| "v"
| "div"
| "s"
| "d"
| "g"
| "m"
| "y"
| "uy"
| "vy"
| "sy"
| "su"
| "suy"
| "sv"
| "svy"
| "my"
| "mu"
| "muy"
| "mv"
| "mvy"
| "ms"
| "msy"
| "msu"
| "msuy"
| "msv"
| "msvy"
| "iy"
| "iu"
| "iuy"
| "iv"
| "ivy"
| "is"
| "isy"
| "isu"
| "isuy"
| "isv"
| "isvy"
| "im"
| "imy"
| "imu"
| "imuy"
| "imv"
| "imvy"
| "ims"
| "imsy"
| "imsu"
| "imsuy"
| "imsv"
| "imsvy"
| "gy"
| "guy"
| "gv"
| "gvy"
| "gs"
| "gsy"
| "gsu"
| "gsuy"
| "gsv"
| "gsvy"
| "gm"
| "gmy"
| "gmu"
| "gmuy"
| "gmv"
| "gmvy"
| "gms"
| "gmsy"
| "gmsu"
| "gmsuy"
| "gmsv"
| "gmsvy"
| "gi"
| "giy"
| "giu"
| "giuy"
| "giv"
| "givy"
| "gis"
| "gisy"
| "gisu"
| "gisuy"
| "gisv"
| "gisvy"
| "gim"
| "gimy"
| "gimu"
| "gimuy"
| "gimv"
| "gimvy"
| "gims"
| "gimsy"
| "gimsu"
| "gimsuy"
| "gimsv"
| "gimsvy"
| "dy"
| "du"
| "duy"
| "dv"
| "dvy"
| "ds"
| "dsy"
| "dsu"
| "dsuy"
| "dsv"
| "dsvy"
| "dm"
| "dmy"
| "dmu"
| "dmuy"
| "dmv"
| "dmvy"
| "dms"
| "dmsy"
| "dmsu"
| "dmsuy"
| "dmsv"
| "dmsvy"
| "di"
| "diy"
| "diu"
| "diuy"
| "divy"
| "dis"
| "disy"
| "disu"
| "disuy"
| "disv"
| "disvy"
| "dim"
| "dimy"
| "dimu"
| "dimuy"
| "dimv"
| "dimvy"
| "dims"
| "dimsy"
| "dimsu"
| "dimsuy"
| "dimsv"
| "dimsvy"
| "dg"
| "dgy"
| "dgu"
| "dguy"
| "dgv"
| "dgvy"
| "dgs"
| "dgsy"
| "dgsu"
| "dgsuy"
| "dgsv"
| "dgsvy"
| "dgm"
| "dgmy"
| "dgmu"
| "dgmuy"
| "dgmv"
| "dgmvy"
| "dgms"
| "dgmsy"
| "dgmsu"
| "dgmsuy"
| "dgmsv"
| "dgmsvy"
| "dgi"
| "dgiy"
| "dgiu"
| "dgiuy"
| "dgiv"
| "dgivy"
| "dgis"
| "dgisy"
| "dgisu"
| "dgisuy"
| "dgisv"
| "dgisvy"
| "dgim"
| "dgimy"
| "dgimu"
| "dgimuy"
| "dgimv"
| "dgimvy"
| "dgims"
| "dgimsy"
| "dgimsu"
| "dgimsuy"
| "dgimsv"
| "dgimsvy" ? any[any] : "">;Defined in: node_modules/.pnpm/[email protected]/node_modules/arkregex/out/regex.d.ts:19
inferNamedCaptures
inferNamedCaptures: ctx["names"] extends NamedCaptures ? any[any] : object;Defined in: node_modules/.pnpm/[email protected]/node_modules/arkregex/out/regex.d.ts:18
lastIndex
lastIndex: number;Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1016
Inherited from
RegExp.lastIndex
multiline
readonly multiline: boolean;Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1014
Returns a Boolean value indicating the state of the multiline flag (m) used with a regular expression. Default is false. Read-only.
Inherited from
RegExp.multiline
source
readonly source: string;Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1005
Returns a copy of the text of the regular expression pattern. Read-only. The regExp argument is a Regular expression object. It can be a variable name or a literal.
Inherited from
RegExp.source
sticky
readonly sticky: boolean;Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.core.d.ts:386
Returns a Boolean value indicating the state of the sticky flag (y) used with a regular expression. Default is false. Read-only.
Inherited from
RegExp.sticky
unicode
readonly unicode: boolean;Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.core.d.ts:392
Returns a Boolean value indicating the state of the Unicode flag (u) used with a regular expression. Default is false. Read-only.
Inherited from
RegExp.unicode
Methods
[match]()
[match](string): RegExpMatchArray | null;Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:187
Matches a string with this regular expression, and returns an array containing the results of that search.
Parameters
string
string
A string to search within.
Returns
RegExpMatchArray | null
Inherited from
RegExp.[match]
[matchAll]()
[matchAll](str): RegExpStringIterator<RegExpExecArray>;Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2020.symbol.wellknown.d.ts:38
Matches a string with this regular expression, and returns an iterable of matches containing the results of that search.
Parameters
str
string
Returns
RegExpStringIterator<RegExpExecArray>
Inherited from
RegExp.[matchAll]
[replace]()
Call Signature
[replace](string, replaceValue): string;Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:196
Replaces text in a string, using this regular expression.
Parameters
string
string
A String object or string literal whose contents matching against this regular expression will be replaced
replaceValue
string
A String object or string literal containing the text to replace for every successful match of this regular expression.
Returns
string
Inherited from
RegExp.[replace]
Call Signature
[replace](string, replacer): string;Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:204
Replaces text in a string, using this regular expression.
Parameters
string
string
A String object or string literal whose contents matching against this regular expression will be replaced
replacer
(substring, ...args) => string
A function that returns the replacement text.
Returns
string
Inherited from
RegExp.[replace]
[search]()
[search](string): number;Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:212
Finds the position beginning first substring match in a regular expression search using this regular expression.
Parameters
string
string
The string to search within.
Returns
number
Inherited from
RegExp.[search]
[split]()
[split](string, limit?): string[];Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:226
Returns an array of substrings that were delimited by strings in the original input that match against this regular expression.
If the regular expression contains capturing parentheses, then each time this regular expression matches, the results (including any undefined results) of the capturing parentheses are spliced.
Parameters
string
string
string value to split
limit?
number
if not undefined, the output array is truncated so that it contains no more than 'limit' elements.
Returns
string[]
Inherited from
RegExp.[split]
compile()
compile(pattern, flags?): this;Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1020
Parameters
pattern
string
flags?
string
Returns
this
Deprecated
A legacy feature for browser compatibility
Inherited from
RegExp.compile
exec()
Call Signature
exec(s):
| RegexExecArray<[pattern, ...(ctx["captures"] extends IndexedCaptures ? any[any] : [])[]], ctx["names"] extends NamedCaptures ? any[any] : object, ctx["flags"] extends
| ""
| "gu"
| "u"
| "i"
| "v"
| "div"
| "s"
| "d"
| "g"
| "m"
| "y"
| "uy"
| "vy"
| "sy"
| "su"
| "suy"
| "sv"
| "svy"
| "my"
| "mu"
| "muy"
| "mv"
| "mvy"
| "ms"
| "msy"
| "msu"
| "msuy"
| "msv"
| "msvy"
| "iy"
| "iu"
| "iuy"
| "iv"
| "ivy"
| "is"
| "isy"
| "isu"
| "isuy"
| "isv"
| "isvy"
| "im"
| "imy"
| "imu"
| "imuy"
| "imv"
| "imvy"
| "ims"
| "imsy"
| "imsu"
| "imsuy"
| "imsv"
| "imsvy"
| "gy"
| "guy"
| "gv"
| "gvy"
| "gs"
| "gsy"
| "gsu"
| "gsuy"
| "gsv"
| "gsvy"
| "gm"
| "gmy"
| "gmu"
| "gmuy"
| "gmv"
| "gmvy"
| "gms"
| "gmsy"
| "gmsu"
| "gmsuy"
| "gmsv"
| "gmsvy"
| "gi"
| "giy"
| "giu"
| "giuy"
| "giv"
| "givy"
| "gis"
| "gisy"
| "gisu"
| "gisuy"
| "gisv"
| "gisvy"
| "gim"
| "gimy"
| "gimu"
| "gimuy"
| "gimv"
| "gimvy"
| "gims"
| "gimsy"
| "gimsu"
| "gimsuy"
| "gimsv"
| "gimsvy"
| "dy"
| "du"
| "duy"
| "dv"
| "dvy"
| "ds"
| "dsy"
| "dsu"
| "dsuy"
| "dsv"
| "dsvy"
| "dm"
| "dmy"
| "dmu"
| "dmuy"
| "dmv"
| "dmvy"
| "dms"
| "dmsy"
| "dmsu"
| "dmsuy"
| "dmsv"
| "dmsvy"
| "di"
| "diy"
| "diu"
| "diuy"
| "divy"
| "dis"
| "disy"
| "disu"
| "disuy"
| "disv"
| "disvy"
| "dim"
| "dimy"
| "dimu"
| "dimuy"
| "dimv"
| "dimvy"
| "dims"
| "dimsy"
| "dimsu"
| "dimsuy"
| "dimsv"
| "dimsvy"
| "dg"
| "dgy"
| "dgu"
| "dguy"
| "dgv"
| "dgvy"
| "dgs"
| "dgsy"
| "dgsu"
| "dgsuy"
| "dgsv"
| "dgsvy"
| "dgm"
| "dgmy"
| "dgmu"
| "dgmuy"
| "dgmv"
| "dgmvy"
| "dgms"
| "dgmsy"
| "dgmsu"
| "dgmsuy"
| "dgmsv"
| "dgmsvy"
| "dgi"
| "dgiy"
| "dgiu"
| "dgiuy"
| "dgiv"
| "dgivy"
| "dgis"
| "dgisy"
| "dgisu"
| "dgisuy"
| "dgisv"
| "dgisvy"
| "dgim"
| "dgimy"
| "dgimu"
| "dgimuy"
| "dgimv"
| "dgimvy"
| "dgims"
| "dgimsy"
| "dgimsu"
| "dgimsuy"
| "dgimsv"
| "dgimsvy" ? any[any] : "">
| null;Defined in: node_modules/.pnpm/[email protected]/node_modules/arkregex/out/regex.d.ts:25
Executes a search on a string using a regular expression pattern, and returns an array containing the results of that search.
Parameters
s
string
Returns
| RegexExecArray<[pattern, ...(ctx["captures"] extends IndexedCaptures ? any[any] : [])[]], ctx["names"] extends NamedCaptures ? any[any] : object, ctx["flags"] extends | "" | "gu" | "u" | "i" | "v" | "div" | "s" | "d" | "g" | "m" | "y" | "uy" | "vy" | "sy" | "su" | "suy" | "sv" | "svy" | "my" | "mu" | "muy" | "mv" | "mvy" | "ms" | "msy" | "msu" | "msuy" | "msv" | "msvy" | "iy" | "iu" | "iuy" | "iv" | "ivy" | "is" | "isy" | "isu" | "isuy" | "isv" | "isvy" | "im" | "imy" | "imu" | "imuy" | "imv" | "imvy" | "ims" | "imsy" | "imsu" | "imsuy" | "imsv" | "imsvy" | "gy" | "guy" | "gv" | "gvy" | "gs" | "gsy" | "gsu" | "gsuy" | "gsv" | "gsvy" | "gm" | "gmy" | "gmu" | "gmuy" | "gmv" | "gmvy" | "gms" | "gmsy" | "gmsu" | "gmsuy" | "gmsv" | "gmsvy" | "gi" | "giy" | "giu" | "giuy" | "giv" | "givy" | "gis" | "gisy" | "gisu" | "gisuy" | "gisv" | "gisvy" | "gim" | "gimy" | "gimu" | "gimuy" | "gimv" | "gimvy" | "gims" | "gimsy" | "gimsu" | "gimsuy" | "gimsv" | "gimsvy" | "dy" | "du" | "duy" | "dv" | "dvy" | "ds" | "dsy" | "dsu" | "dsuy" | "dsv" | "dsvy" | "dm" | "dmy" | "dmu" | "dmuy" | "dmv" | "dmvy" | "dms" | "dmsy" | "dmsu" | "dmsuy" | "dmsv" | "dmsvy" | "di" | "diy" | "diu" | "diuy" | "divy" | "dis" | "disy" | "disu" | "disuy" | "disv" | "disvy" | "dim" | "dimy" | "dimu" | "dimuy" | "dimv" | "dimvy" | "dims" | "dimsy" | "dimsu" | "dimsuy" | "dimsv" | "dimsvy" | "dg" | "dgy" | "dgu" | "dguy" | "dgv" | "dgvy" | "dgs" | "dgsy" | "dgsu" | "dgsuy" | "dgsv" | "dgsvy" | "dgm" | "dgmy" | "dgmu" | "dgmuy" | "dgmv" | "dgmvy" | "dgms" | "dgmsy" | "dgmsu" | "dgmsuy" | "dgmsv" | "dgmsvy" | "dgi" | "dgiy" | "dgiu" | "dgiuy" | "dgiv" | "dgivy" | "dgis" | "dgisy" | "dgisu" | "dgisuy" | "dgisv" | "dgisvy" | "dgim" | "dgimy" | "dgimu" | "dgimuy" | "dgimv" | "dgimvy" | "dgims" | "dgimsy" | "dgimsu" | "dgimsuy" | "dgimsv" | "dgimsvy" ? any[any] : ""> | null
Overrides
RegExp.exec
Call Signature
exec(s): never;Defined in: node_modules/.pnpm/[email protected]/node_modules/arkregex/out/regex.d.ts:26
Executes a search on a string using a regular expression pattern, and returns an array containing the results of that search.
Parameters
s
string
Returns
never
Overrides
RegExp.exec
test()
test(s): s is pattern;Defined in: node_modules/.pnpm/[email protected]/node_modules/arkregex/out/regex.d.ts:24
Returns a Boolean value that indicates whether or not a pattern exists in a searched string.
Parameters
s
string
Returns
s is pattern
Overrides
RegExp.test