Package Exports
- better-history-api
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (better-history-api) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
I needed to interact with the browser's History object, but it was too mind-bending. So I made this abstraction and then I was able to get my job done.
These functions update and return state using a single property on the real state object, minimizing your odds of bashing history state set by some other part of your app when you use this API.
API
const historyState = require('better-history-api')historyState.update(newState)
Updates the existing state for the current history item.
The new state object you pass in is merged with the existing state with Object.assign.
state = historyState.get()
Returns the state object for the current history item.
historyState.addBeforePushStateMiddleware(fn)
This adds a callback/middlewarey function that will be called before pushState is called, no matter who is calling pushState.
Your function will be passed the current (pre-pushState) state, and will give you a chance to change it before the history stack changes.
historyState.addBeforePushStateMiddleware(
state => Object.assign(state, { position: currentScrollPosition() })
)Events
The historyState object is an event emitter that emits these events:
new state
Emitted immediately after pushState is called, while the state object is fresh and shiny.
old state
Emitted whenever a popstate event happens with any associated state. Emits the state object.