Location: replace() method

{{ APIRef("HTML DOM") }} 

The replace() method of the {{DOMXref("Location")}}  interface replaces the current resource with the one at the provided URL. The difference from the {{domxref("Location.assign","assign()")}}  method is that after using replace() the current page will not be saved in session {{domxref("History")}} , meaning the user won’t be able to use the back button to navigate to it. Not to be confused with the {{jsxref("String")}}  method {{jsxref("String.prototype.replace()")}} .

Syntax

replace(url)

Parameters

• url
  • : A string or any other object with a {{Glossary("stringifier")}} , such as a {{domxref("URL")}}  object, containing the URL of the page to navigate to.

Exceptions

• SecurityError {{domxref("DOMException")}} 
  • : Browsers throttle navigations and may throw this error, generate a warning, or ignore the call if it’s called too frequently.
• SyntaxError {{domxref("DOMException")}} 
  • : Thrown if the provided url parameter is not a valid URL.

Return value

None ({{jsxref("undefined")}} ).

Examples

// Navigate to the Location.reload article by replacing this page
window.location.replace(
  "https://developer.mozilla.org/en-US/docs/Web/API/Location.reload",
);

Specifications

{{Specifications}} 

Browser compatibility

{{Compat}} 

See also

• The {{domxref("Location")}}  interface it belongs to.
• Similar methods: {{domxref("Location.assign()")}}  and {{domxref("Location.reload()")}} .