replace

Resumen

Halla un emparejamiento entre una expresión regular y una cadena, y reemplaza la subcadena emparejada con una nueva subcadena.

Método de String
Implementado en: JavaScript 1.2

JavaScript 1.3 añade la capacidad de especificar una función como segundo parámetro.

Versión ECMA: ECMA-262

Sintaxis

var nuevaCadena = cadena.replace(expresionregular/subcadena, nuevaSubcadena/funcion[, flags]);

Parámetros

expresionregular 
Un objeto RegExp. El emparejamiento es reemplazado por el valor de devuelto por el segundo parámetro.
subcadena 
Un objeto String que será reemplazado por nuevaSubcadena.
nuevaSubcadena 
El objeto String que reemplaza la subcadena que recibida desde el primer parámetro.
funcion 
Una función que será invocada para crear la nueva subcadena (para ponerla en lugar de la subcadena recibida por el primer parámetro).
flags 
(extensión SpiderMonkey) Un objeto String que contiene cualquier combinación de flags de la clase RegExp: g - emparejamiento global, i - ignorar mayúsculas, m - emparejar multiples líneas. Este parámetro se usa sólo si el primer parámetro es una cadena.

Descripción

Este método no cambia el objeto String sobre el que se realiza la llamada. Simplemente devuelve una nueva cadena.

Para realizar una búsqueda global y reemplazarla, o se incluye el flag g en la expresión regular o si el primer parámetro es una cadena, se incluye g en el parámetro flags.

Especificando una cadena como un parámetro

La cadena de reemplazo puede incluir los siguientes patrones de reemplazo especiales:

Patrón Inserta
$$ Inserta una "$".
$& Inserta la subcadena emparejada.
$` Inserta la sección de cadena que precede a la subcadena emparejada.
$' Inserta la porción de subcadena que sigue a la subcadena emparejada.
$n o $nn Donde n o nn son dígitos decimales, inserta la subcadena emparejada de orden n del paréntesis, proporcionado por el primer argumento del objeto RegExp.

Especificando una función con un parámetro

When you specify a function as the second parameter, the function is invoked after the match has been performed. (The use of a function in this manner is often called a lambda expression.)

In your function, you can dynamically generate the string that replaces the matched substring. The result of the function call is used as the replacement value.

The nested function can use the matched substrings to determine the new string (newSubStr) that replaces the found substring. You get the matched substrings through the parameters of your function. The first parameter of your function holds the complete matched substring. If the first argument was a RegExp object, then the following n parameters can be used for parenthetical matches, remembered submatch strings, where n is the number of submatch strings in the regular expression. Finally, the last two parameters are the offset within the string where the match occurred and the string itself. For example, the following replace method returns XXzzzz - XX , zzzz.

function replacer(str, p1, p2, offset, s)
{
  return str + " - " + p1 + " , " + p2;
}
var newString = "XXzzzz".replace(/(X*)(z*)/, replacer);

Ejemplos

Ejemplo: Using global and ignore with replace

In the following example, the regular expression includes the global and ignore case flags which permits replace to replace each occurrence of 'apples' in the string with 'oranges'.

var re = /apples/gi;
var str = "Apples are round, and apples are juicy.";
var newstr = str.replace(re, "oranges");
print(newstr);

In this version, a string is used as the first parameter and the global and ignore case flags are specified in the flags parameter.

var str = "Apples are round, and apples are juicy.";
var newstr = str.replace("apples", "oranges", "gi");
print(newstr);

Both of these examples print "oranges are round, and oranges are juicy."

Ejemplo: Definiendo la expresión regular en replace

En el siguiente ejemplo, se define la expresión regular en replace e incluye el flag de ignorar mayúsculas.

var cadena = "Twas the night before Xmas...";
var nuevaCadena = cadena.replace(/xmas/i, "Christmas");
print(nuevaCadena);

Esto muestra "Twas the night before Christmas..."

Ejemplo: Conectando palabras en una cadena

El siguiente código conecta las palabras dentro de la cadena. Para reemplazar el texto, el código usa $1 y $2 como patrones de reemplazo.

var expresion = /(\w+)\s(\w+)/;
var cadena = "John Smith";
var nuevaCadena = cadena.replace(expresion, "$2, $1");
print(nuevaCadena);

Esto muestra "Smith, John".

Ejemplo: Using an inline function that modifies the matched characters

In this example, all occurrences of capital letters in the string are converted to lower case, and a hyphen is inserted just before the match location. The important thing here is that additional operations are needed on the matched item before it is given back as a replacement.

The replacement function accepts the matched snippet as its parameter, and uses it to transform the case and concatenate the hyphen before returning.

function styleHyphenFormat(propertyName)
{
  function upperToHyphenLower(match)
  {
    return '-' + match.toLowerCase();
  }
  return propertyName.replace(/[A-Z]/, upperToHyphenLower);
}

Given styleHyphenFormat('borderTop'), this returns 'border-top'.

Because we want to further transform the result of the match before the final substitution is made, we must use a function. This forces the evaluation of the match prior to the toLowerCase() method. If we had tried to do this using the match without a function, the toLowerCase() would have no effect.

var newString = propertyName.replace(/[A-Z]/, '-' + '$&'.toLowerCase());  // won't work

This is because '$&'.toLowerCase() would be evaluated first as a string literal (resulting in the same '$&') before using the characters as a pattern.

Ejemplo: Reemplazando grandos Fahrenheit con su equivalente Celsius

El siguiente ejemplo reemplaza los grados Fahrenheit con su enquivalente en grados Celsius. Los grados Fahrenheit deberían ser un número acabado en F. La función devuelve el número Celsius acabado en C. Por ejemplo, si el número de entrada es 212F, la función devuelve 100C. Si el número es 0F, la función devuelve -17.77777777777778C.

La expresión regular test revisa si para un número termina en F. El número de grados Fahrenheit es accesible a la función a través de su segundo parámetro, p1. La función establece el número Celsius basado en los grados Fahrenheit pasados en una cadena a la función f2c. Entonces f2c devuelve el número Celsius. Esta función aproxima al flag de Perl s///e.

function f2c(x)
{
  function convert(str, p1, offset, s)
  {
    return ((p1-32) * 5/9) + "C";
  }
  var s = String(x);
  var test = /(\d+(?:\.\d*)?)F\b/g;
  return s.replace(test, convert);
}


Etiquetas y colaboradores del documento

Colaboradores de esta página: Mgjbot, Talisker
Última actualización por: Talisker,