PopStateEvent: PopStateEvent() constructor
The PopStateEvent()
constructor creates a new PopStateEvent
object.
Note: A web developer doesn't typically need to call this constructor, as the browser creates these objects itself when firing popstate
events.
Syntax
js
new PopStateEvent(type, options)
Parameters
type
-
A string with the name of the event. It is case-sensitive and browsers set it to
popstate
. options
Optional-
An object that, in addition to the properties defined in
Event()
, has the following property:state
Optional-
An object representing the state. Practically it is a value provided by the call to
history.pushState()
orhistory.replaceState()
. If not set, it defaults tonull
.
Return value
A new PopStateEvent
object.
Specifications
Specification |
---|
HTML Standard # the-popstateevent-interface |
Browser compatibility
BCD tables only load in the browser