@firebase/messaging-compat

What is @firebase/messaging-compat?

The @firebase/messaging-compat package is a compatibility layer for Firebase Cloud Messaging (FCM) that allows developers to use the modern Firebase Messaging API in applications that still rely on the older Firebase JavaScript SDKs. This package enables seamless integration of messaging functionalities in web applications to send and receive messages across platforms efficiently.

What are @firebase/messaging-compat's main functionalities?

Receive messages

This feature allows the application to receive messages sent from the Firebase Console or other backend services. The code sample demonstrates how to set up a listener that triggers whenever a new message is received while the app is in the foreground.

import { getMessaging, onMessage } from '@firebase/messaging-compat';

const messaging = getMessaging();
onMessage(messaging, (payload) => {
  console.log('Message received. ', payload);
  // handle the received payload
});

Retrieve an instance token

This feature is used to retrieve the current token for the client app instance. A valid VAPID key is required to authenticate the token request. This token is essential for sending messages to the user's device.

import { getMessaging, getToken } from '@firebase/messaging-compat';

const messaging = getMessaging();
getToken(messaging, { vapidKey: 'your-vapid-key' }).then((currentToken) => {
  if (currentToken) {
    console.log('Token retrieved: ', currentToken);
  } else {
    console.log('No Instance ID token available. Request permission to generate one.');
  }
}).catch((err) => {
  console.error('An error occurred while retrieving token. ', err);
});

Other packages similar to @firebase/messaging-compat

firebase-messaging

firebase-messaging is the modern version of Firebase Cloud Messaging integration for web applications. Unlike @firebase/messaging-compat, it is designed for use with the latest Firebase SDKs and supports additional features like background message handling and improved payload management. It is more suitable for new projects that do not require compatibility with older Firebase versions.

push.js

push.js is a JavaScript library that allows web developers to send push notifications to users' browsers. It is not tied to Firebase and works with any backend, providing more flexibility in terms of setup and usage. However, it lacks the integrated backend services and analytics provided by Firebase.

README

@firebase/messaging-compat

This is the compat package that recreates the v8 APIs.

This package is not intended for direct usage, and should only be used via the officially supported firebase package.