RegExResult

Description

A class that handles the results of a RegEx match

The RegExResult class is returned from the string.match() method. The RegExResult can be used to iterate over all matches in the string. This is usually done with as shown in the following example:

string toMatch = "Processor1 Processor200";
Array matches;
var result = toMatch.match(/([a-zA-Z]+)(\d+)/g);
while ((matches = result.findNextMatch()).length) {
	pt(matches.join(", "));
	pr();
}
// Text printed to Output Console:
// Processor1, Processor, 1
// Processor200, Processor, 200

The string is not actually searched until one of the methods or properties are called. Then, the string is only searched until the requested information can be provided. Once a match is found, it is cached, so that future calls that require that match can look it up.

Unless you mark the RegEx as global (using the "g" flag), this object will only search until it finds the first match. None of the methods or properties will cause it to search beyond that point.

Creating RegExResult Objects

var result = someString.match(/a pattern/g); // correct
// RegExResult result = someString.match(/a pattern/g); INCORRECT
// RegExResult result; INCORRECT
	

Properties

Methods

Operators