npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@techins/pushnotiflib

v1.1.28

Published

A wrapper around firebase that shows push notifications, offering a hassle-free to setup api.

Downloads

33

Readme

Ez push notification JS lib

An api wrapper around firebase aiming to offer a trouble-free usage of firebase upon legacy es-5 projects.

Usage via CDN

Step 1: Load Js Scripot through CDN

    <script src="https://cdn.jsdelivr.net/npm/@techins/pushnotiflib@latest/dist/firebaseLib.umd.js"></script>

Step 2: Create firebase-messaging-sw.js

Ensure that firebase-messaging-sw.js is servesd through / and via https.

In order for the firebase to work you must create a file firebase-messaging-sw.js. The file should be accessible via https at:

https://^your_domain^/firebase-messaging-sw.js

Keep in mind that firebase-messaging-sw.js does not work if not served in http as mentioned above.

firebase-messaging-sw.js content

Its content should be:

importScripts("https://cdn.jsdelivr.net/npm/@techins/pushnotiflib@latest/dist/firebase-messaging-sw.js");

const firebaseConfig = {
    // Replace firebase config from firebase console
};

self.initServiceWorker(firebaseConfig);

The firebaseConfig is the config generated from the firebase console.

Step 3 Use the library:

The library can be used like this:

const firebaseConfig = {
    // Firebase config
};
            

const vapidKey = ""; // Also generated from firebase console

// Initialize Firebase  
firebaseLib.pushNotificationInit(firebaseConfig,vapidKey)

Both firebaseConfig and vapidKey are retrieved from firebase console.

Further token reiceival handling:

The function pushNotificationInit recieves the folloing arguments (with rthe order provided):

  • firebaseConfig that is the configuration received from firebase console
  • vapidKey that also received via firebase console
  • tokenNotificationCallback As documented bellow (optional)
  • workerAsModule that indicates whether worker should be loaded as a module or not.

Upon token receival you can offer to be processed futher via providing a callback function at tokenNotificationCallback. The function provided should be like this:

function(token,proceedCallback)
{
  // Send token via ajax or do stuff
}

In order to receive messages you must call proceedCallback function. In order to indicate that the process sucessfully has been ended you should do:

function(token,proceedCallback)
{
  // Send token via ajax or do stuff
  proceedCallback() // Success
}

Otherwise you should provide the error as an argument:

function(token,proceedCallback)
{
  // Send token via ajax or do stuff
  proceedCallback() // Success
}

A full working example is:

const firebaseConfig = {
    // Firebase config
};
            

const vapidKey = ""; // Also generated from firebase console

function handleToken(token,proceedCallback)
{
  // Send token via ajax or do stuff
  proceedCallback()
}

// Initialize Firebase  
firebaseLib.pushNotificationInit(firebaseConfig,vapidKey,handleToken)