String.prototype.replaceAll()

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since August 2020.

La méthode replaceAll() retourne une nouvelle chaîne de caractères dans laquelle toutes les occurrences d'un motif donné ont été remplacées par une chaîne de remplacement. L'argument pattern fournit pour décrire le motif peut être une chaîne de caractères ou une expression rationnelle (RegExp), l'argument replacement peut être une chaîne de caractères ou une fonction qui sera appelée pour chaque correspondance.

La chaîne de caractères initiale restera inchangée.

Exemple interactif

Syntaxe

js
const newStr = str.replaceAll(regexp|substr, newSubstr|function)

Note : Quand on utilise une expression rationnelle, il est nécessaire d'utiliser le marqueur global ("g"); autrement, l'exception TypeError: "replaceAll must be called with a global RegExp" sera levée.

Paramètres

regexp (le motif à rechercher)

Un objet ou littérale RegExp avec le marqueur global. Les correspondances sont remplacées par newSubstr ou la valeur retournée par la function spécifiée. Une RegExp sans le marqueur global ("g") renverra l'erreur TypeError: "replaceAll must be called with a global RegExp".

substr

Une chaîne de caractères (String) qui sera remplacée par newSubstr. Elle est traitée comme une chaîne de caracères littérale et non pas comme une expression régulière.

newSubstr (remplacement)

La chaîne de caractères (String) qui remplacera la sous-chaîne indiquée par la regexp ou substr donnée en paramètre. Un certain nombre de motifs spéciaux pour le remplacement sont pris en charge, voir la section "Spécifier une chaîne de caractères comme paramètre" ci-dessous.

function (remplacement)

Une fonction qui a pour but de créer la nouvelle sous-chaîne qui remplacera les occurrences trouvées via la regexp ou substr donnée en paramètre. Les arguments passés à cette fonction sont détaillés dans la section "Spécifier une fonction comme paramètre" ci-dessous.

Valeur de retour

Une nouvelle chaîne avec toutes les occurrences trouvées remplacées par le pattern de remplacement.

Description

Cette méthode ne remplace ni ne modifie l'objet String original. Elle retourne juste une nouvelle chaîne de caractères.

Spécifier une chaîne de caractères comme paramètre

La chaîne de caractères de remplacement peut inclure les motifs de remplacement spéciaux suivants :

Motif Insertion
$$ Insère un "$".
$& Insère la chaîne de caractères trouvée.
$` Insère la portion de chaîne de caractères qui précède celle trouvée.
$' Insère la portion de chaîne de caractères qui suit celle trouvée.
$n Où n est un entier positif inférieur à 100. Insère la n-ième occurrence trouvée, à condition que le premier argument soit un objet RegExp. Cet indice démarre à partir de 1.

Spécifier une fonction comme paramètre

Vous pouvez passer une fonction comme second paramètre. Dans ce cas, la fonction sera appelée après qu'une occurrence soit trouvée. Le résultat de la fonction (valeur de retour) sera utilisé comme chaîne de remplacement. (Note : les remplacements spéciaux mentionnés plus haut ne s'appliqueront pas dans ce cas.)

À noter que la fonction sera utilisée à chaque fois qu'une occurrence sera rencontrée, si l'expression régulière donnée en paramètre est globale.

La fonction admet les arguments suivants :

Nom possible Valeur fournie
match L'occurrence trouvée. (Correspond au $& du précédent tableau.)
p1, p2…

Le n-ième chaîne de caractères trouvée par une sous-correspondance entre parenthèses, à condition que le premier paramètre soit un objet de type RegExp.
(Correspond aux $1, $2… précédents.) Par exemple, si /(\a+)(\b+)/ a été passé en paramètre, p1 est la correspondance pour \a+, et p2 pour \b+.

offset Le décalage de la sous-chaîne trouvée dans la chaîne d'entrée (par exemple, si la chaîne complète d'entrée était 'abcd' et la sous-chaîne 'bc' alors, cet argument vaudra 1.)
string La chaîne compète examinée.

Le nombre d'arguments exact dépend du premier argument de replaceAll() : si c'est un objet de type RegExp et, si tel est le cas, du nombre de sous-correspondances entre parenthèses qu'il spécifie.

Exemples

Utiliser replaceAll()

js
"aabbcc".replaceAll("b", ".");
// 'aa..cc'

Exceptions pour les expressions rationnelles non globales

Quand on utilise une expression rationnelle pour chercher une valeur, celle-ci doit être globale. Le code suivant ne fonctionnera pas :

js
'aabbcc'.replaceAll(/b/, '.');
TypeError: replaceAll must be called with a global RegExp

L'exemple suivant, utilisant le marqueur g, fonctionnera :

js
"aabbcc".replaceAll(/b/g, ".");
("aa..cc");

Spécifications

Specification
ECMAScript Language Specification
# sec-string.prototype.replaceall

Compatibilité des navigateurs

BCD tables only load in the browser

Voir aussi