Symbol.match
Baseline
Widely available
Cette fonctionnalité est bien établie et fonctionne sur de nombreux appareils et versions de navigateurs. Elle est disponible sur tous les navigateurs depuis janvier 2020.
Le symbole Symbol.match définit la correspondance d'une expression rationnelle par rapport à une chaîne de caractères. Cette fonction est appelée par la méthode String.prototype.match().
Exemple interactif
const regexp1 = /foo/;
// console.log('/foo/'.startsWith(regexp1));
// Expected output (Chrome): Error: First argument to String.prototype.startsWith must not be a regular expression
// Expected output (Firefox): Error: Invalid type: first can't be a Regular Expression
// Expected output (Safari): Error: Argument to String.prototype.startsWith cannot be a RegExp
regexp1[Symbol.match] = false;
console.log("/foo/".startsWith(regexp1));
// Expected output: true
console.log("/baz/".endsWith(regexp1));
// Expected output: false
Description
Cette fonction est également utilisée pour identifier les objets qui jouent un rôle avec les expressions rationnelles. Ainsi, les méthodes String.prototype.startsWith(), String.prototype.endsWith() et String.prototype.includes() vérifient si leur premier argument est une expression rationnelle et lèvent une exception TypeError si c'est le cas. Si le symbole match est modifié et vaut une valeur false (ou équivalente), cela indique que l'objet ne doit pas être utilisé comme une expression rationnelle.
Attributs de Symbol.match | |
|---|---|
| Écrivable | Non |
| Énumérable | Non |
| Configurable | Non |
Exemples
Le code suivant renverra une exception TypeError :
"/truc/".startsWith(/truc/);
// lève une TypeError car /truc/
// est une expression rationnelle
// et que Symbol.match n'a pas été modifié.
Cependant, si Symbol.match vaut false, cette vérification isRegExp indiquera que l'objet à prendre en compte n'est pas une expression rationnelle. Les méthodes startsWith et endsWith ne déclencheront donc pas d'exception TypeError.
var re = /toto/;
re[Symbol.match] = false;
"/toto/".startsWith(re); // true
"/truc/".endsWith(re); // false
Spécifications
| Specification |
|---|
| ECMAScript® 2026 Language Specification # sec-symbol.match |
Compatibilité des navigateurs
Chargement…