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

@arunvaradharajalu/common.firebase-cloud-messaging

v1.1.0

Published

This package contains wrapper for firebase cloud messaging

Downloads

10

Readme

@arunvaradharajalu/common.firebase-cloud-messaging

npm version GitHub issues GitHub license

This package contains a wrapper for Firebase Cloud Messaging (FCM), making it easier to interact with FCM in your Node.js applications.

Installation

To install the package, run:

npm install @arunvaradharajalu/common.firebase-cloud-messaging

Usage

Here's a basic example of how to use this package:

import { firebaseCloudMessaging } from "@arunvaradharajalu/common.firebase-cloud-messaging";

// Set your Firebase configuration
firebaseCloudMessaging.name = "your-fcm-app-name";
firebaseCloudMessaging.projectId = "your-project-id";
firebaseCloudMessaging.clientEmail = "your-client-email";
firebaseCloudMessaging.privateKey = "your-private-key";

// Initialize Firebase Cloud Messaging
firebaseCloudMessaging.init();

// Create a message to send
const message = {
  token: "recipient-fcm-token",
  notification: {
    title: "Hello",
    body: "World"
  }
};

// Send the message
firebaseCloudMessaging.send(message)
  .then(response => {
    console.log("Successfully sent message:", response);
  })
  .catch(error => {
    console.error("Error sending message:", error);
  });

API

Properties

  • name: Sets the name of the Firebase application.
  • projectId: Sets the project ID of your Firebase project.
  • clientEmail: Sets the client email for Firebase authentication.
  • privateKey: Sets the private key for Firebase authentication.
  • fcm: Gets the initialized Firebase app instance.

Methods

  • init(): Initializes the Firebase app with the provided configuration.
  • send(message: FcmMessage, dryRun?: boolean): Promise<string>: Sends a message to a device. Optionally performs a dry run (validation only).

Errors

This package uses custom error classes from @arunvaradharajalu/common.errors for specific error scenarios:

  • FirebaseCloudMessagingConnectionError: Thrown when FCM is not properly initialized before usage.

Running Tests

To run the tests, use:

npm test

The test results will be generated in an HTML report with the title "FIrebase Cloud Messaging Test Report".

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue for bug fixes, improvements, or new features.

Author

Arun Varadharajalu

License

This project is licensed under the ISC License.