La méthodesubstring() retourne une sous-chaîne de la chaîne courante, entre un indice de début et un indice de fin.

Exemple interactif

const str = "Mozilla";console.log(str.substring(1, 3));// Expected output: "oz"console.log(str.substring(2));// Expected output: "zilla"

Syntaxe

str.substring(indiceA[, indiceB])

Paramètres

indiceA

Un entier compris entre 0 et la longueur de la chaîne.

indiceB

Paramètre optionnel : un entier compris entre 0 et la longueur de la chaine.

Valeur de retour

Une nouvelle chaîne de caractères qui correspond à la section souhaitée de la chaîne appelante.

Description

substring extrait des caractères de la chaîne courante à partir deindiceA jusqu'àindiceB (non compris). On a notamment :

• SiindiceA est égal àindiceB,substring retournera une chaîne vide.
• SiindiceB est omis,substring effectuera l'extraction des caractères jusqu'à la fin de la chaîne.
• Si l'un des deux arguments est négatif ou vautNaN, il sera traité comme 0.
• Si l'un des deux arguments est plus grand questr.length, il sera traité commestr.length.

SiindiceA est supérieur àindiceB, la fonctionsubstring() intervertira ces deux valeurs afin de les traiter comme si elles avaient été passées dans le bon ordre. Par exemple :str.substring(1, 0) == str.substring(0, 1).

Exemples

Utilisersubstring()

Les exemples suivants utilisent la méthodesubstring() pour extraire et afficher des caractères à partir de la chaine "Mozilla" :

var uneChaîne = "Mozilla";// Affiche "Moz"console.log(uneChaîne.substring(0, 3));console.log(uneChaîne.substring(3, 0));// Affiche "lla"console.log(uneChaîne.substring(4, 7));console.log(uneChaîne.substring(4));console.log(uneChaîne.substring(7, 4));// Affiche "Mozill"console.log(uneChaîne.substring(0, 6));// Affiche "Mozilla"console.log(uneChaîne.substring(0, 7));console.log(uneChaîne.substring(0, 10));

Remplacer une sous-chaîne dans une chaîne

L'exemple suivant remplace une partie d'une chaine. Elle remplace à la fois les caractères individuels et les sous-chaines. La fonction appelée à la fin de cet exemple transforme la chaine "Brave New World" en "Brave New Web".

function replaceString(oldS, newS, fullS) {  // On remplace oldS avec newS dans fullS  for (var i = 0; i < fullS.length; i++) {    if (fullS.substring(i, i + oldS.length) == oldS) {      fullS =        fullS.substring(0, i) +        newS +        fullS.substring(i + oldS.length, fullS.length);    }  }  return fullS;}replaceString("World", "Web", "Brave New World");

Attention : ceci peut résulter en une boucle infinie sioldS est elle-même une sous-chaine denewS — par exemple, si on essaie de remplacer "World" par "OtherWorld". Une meilleure solution serait de remplacer les chaines de cette manière :

function replaceString(oldS, newS, fullS) {  return fullS.split(oldS).join(newS);}

Le code ci-dessus sert d'exemple pour les opérations sur les sous-chaines. S'il est nécessaire de remplacer des sous-chaines, la plupart du temps il faudrait préférer l'utilisation deString.prototype.replace().

Différence entresubstring() etsubstr()

Il existe une légère différence entre les méthodessubstring() etsubstr(). Les deux ne doivent pas être confondues.

Les arguments de la méthodesubstring() représentent les indices de début et de fin sur la chaîne. Poursubstr(), les arguments représentent l'indice de début et le nombre de caractères à utiliser pour la chaîne résultante.

var texte = "Mozilla";console.log(texte.substring(2, 5)); // => "zil"console.log(texte.substr(2, 3)); // => "zil"

Différences entresubstring() etslice()

Les méthodessubstring() etslice() sont très proches mais certaines différences les distinguent, notamment la façon de gérer les arguments négatifs.

La méthodesubstring() échangera les deux arguments siindiceA est supérieur àindiceB et renverra donc une chaîne de caractères. La méthodeslice() n'échange pas les arguments et renvoie donc une chaîne vide si le premier est supérieur au second :

var text = "Mozilla";console.log(text.substring(5, 2)); // => "zil"console.log(text.slice(5, 2)); // => ""

Si l'un ou l'autre des arguments sont négatifs ou valentNaN, la méthodesubstring() les traitera comme s'ils valaient0.

console.log(text.substring(-5, 2)); // => "Mo"console.log(text.substring(-5, -2)); // => ""

slice() traite égalementNaN comme0, mais parcourt la chaîne à partir de la fin lorsque des arguments négatifs sont utilisés.

console.log(text.slice(-5, 2)); // => ""console.log(text.slice(-5, -2)); // => "zil"

Pour plus d'exemples sur l'utilisation d'arguments négatifs, voir la pageslice().

Spécifications

Compatibilité des navigateurs

Voir aussi

• String.prototype.substr()Obsolète
• String.prototype.slice()