location.replace

The Location.replace() method replaces the current resource with the one at the provided URL. The difference from the assign() method is that after using replace() the current page will not be saved in session History, meaning the user won't be able to use the back button to navigate to it.

If the assignment can't happen because of a security violation, a DOMException of the SECURITY_ERROR type is thrown. This happens if the origin of the script calling the method is different from the origin of the page originally described by the Location object, mostly when the script is hosted on a different domain.

If the provided URL is not valid, a DOMException of the SYNTAX_ERROR type is thrown.

Syntax

object.replace(url);

Parameters

url

Is a DOMString containing the URL of the page to navigate to.

Examples

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

Specifications

Specification	Status	Comment
WHATWG HTML Living Standard The definition of 'Location.replace()' in that specification.	Living Standard	No change from HTML5.
HTML5 The definition of 'Location.replace()' in that specification.	Recommendation	Initial definition.

Browser compatibility

See also

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