Table of Contents
- Example app
- Service worker
- Constructor parameters
- Instance methods
- Static methods
- Version 1.1.1
Wrapper around Push and Notifications API. Handles subscription and unsubscription. Provides some useful methods.
Needs service worker to be installed in any way. Provides an interface to perform service worker installation if needed.
You can find a basic example application including manifest.json and fully commented service worker in the
To run the app use
npm run local command and navigate to http://localhost:5001.
;const push = ; // All arguments are optionalpush;push;
There is a simple service worker provided with this package. It's needed to make notification events to work properly. You may use it as is, but the best way is to import it in your service worker, as shown in the example.
An options object that can contain some callbacks and a path to the service worker.
stateChangeCb: receives state and an Error object if an error occurred.
subscriptionUpdateCb: receives subscription object (PushSubscription).
logCb: receives anything that should be logged.
Creates and returns new subscription if it does n't exist, returns old otherwise.
Tries to unsubscribe. Returns resolved Promise anyway.
Returns permission state. See
Requests user permission to show notifications. Returns resolved or rejected Promise depending on user decision.
Checks browser support and returns Boolean.
Same as PushManager.getSubscription().