RegExp.prototype.test()

Die test() Methode führt eine Suche nach einer Übereinstimmung zwischen einer reguar expression und einem String durch. Sie gibt  true oder false zurück.

Der Quellcode dieses interaktiven Beispiels befindet sich in einer GitHub repository. Wenn Sie sich an diesem Projekt beteiligen möchten, clonen Sie bitte https://github.com/mdn/interactive-examples und senden Sie uns einen pull request.

Syntax

regexObj.test(str)

Parameter

str

Der String, mit dem die regular expression verglichen wird.

Rückgabewerte

true wird zurückgegeben, wenn es eine Übereinstimmung zwischen der regular expression und dem String gibt str. Anderenfalls wird false zurückgegeben.

Beschreibung

Verwenden Sie test(), wenn Sie wissen möchten, ob ein Muster auf einen String zutrifft. test() gibt einen boolschen Wert zurück, wohingegen die String.prototype.search() Methode den Index der Übereinstimmung, oder wenn keine Übereinstimmung gefunden wird,  -1 zurück gibt.

Um mehr Informationen zu erhalten, können Sie alternativ die langsammere exec() Methode verwenden. (Sie ähnelt String.prototype.match() Methode.)

As with exec() (or in combination with it), test() called multiple times on the same global regular expression instance will advance past the previous match.

Beispiele

test() anwenden

Simple example that tests if "hello" is contained at the very beginning of a string, returning a boolean result.

const str = 'hello world!';
const result = /^hello/.test(str);

console.log(result); // true

The following example logs a message which depends on the success of the test:

function testInput(re, str) {
  let midstring;
  if (re.test(str)) {
    midstring = 'contains';
  } else {
    midstring = 'does not contain';
  }
  console.log(`${str} ${midstring} ${re.source}`);
}

Using test() on a regex with the "global" flag

When a regex has the global flag set, test() will advance the lastIndex of the regex. (RegExp.prototype.exec() also advances the lastIndex property.)

Further calls to test(str) will resume searching str starting from lastIndex. The lastIndex property will continue to increase each time test() returns true. 

When test() returns false, the calling regex's lastIndex property will reset to 0.

The following example demonstrates this behaviour:

const regex = /foo/g; // the "global" flag is set

// regex.lastIndex is at 0
regex.test('foo')     // true

// regex.lastIndex is now at 3
regex.test('foo')     // false

// regex.lastIndex is at 0
regex.test('barfoo')  // true

// regex.lastIndex is at 6
regex.test('foobar')  //false

// regex.lastIndex is at 0
// (...and so on)

Specifications

Browser compatibility

Firefox-specific notes

Prior to Firefox 8, test() was implemented incorrectly. When called without parameters, it would match against the value of the previous input (RegExp.input property) instead of against the string "undefined".

This is fixed. Now, /undefined/.test() correctly results in true, instead of throwing an error.

See also

• Regular Expressions chapter in the JavaScript Guide
• RegExp
• RegExp.prototype