Package Exports
- fcm-cloudflare-workers
- fcm-cloudflare-workers/dist/index.js
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 (fcm-cloudflare-workers) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
fcm-cloudflare-workers
Send multicast notifications using the FCM HTTP v1 API. This project is a fork of fcm-http2 and has been modified to work with Cloudflare Workers.
Features supported by fcm-cloudflare-workers:
- HTTP/2 session & stream concurrency
- Token batching support
- Uninstall detection
- Retry mechanism
How to use?
First you need to install the library via npm:
npm i fcm-cloudflare-workers
Once the library has been installed you can start using it in this way:
import { FCM, FcmOptions, FcmMessage } from "fcm-cloudflare-workers";
// Init FCM with options
const fcmOptions = new FcmOptions(
// Pass in your service account JSON private key file (https://console.firebase.google.com/u/0/project/_/settings/serviceaccounts/adminsdk)
serviceAccount: JSON.parse(env.FIREBASE_SERVICE_ACCOUNT_JSON),
// Max number of concurrent HTTP/2 sessions (connections)
maxConcurrentConnections: 10,
// Max number of concurrent streams (requests) per session
maxConcurrentStreamsAllowed: 100
);
const fcmClient = new FCM(fcmOptions);
// Token to send the notification to
const tokens = ['TOKEN_1', 'TOKEN_N'];
// Composing the message to be sent
const message = {
notification: {
title: "Test",
body: "Multiple Send"
},
data: {
notification: "true"
}
} as FcmMessage;
// Multiple sending of notification using token array
fcmClient.sendMulticast(message, tokens).then(unregisteredTokens => {
// Sending successful
console.log('Message sent successfully');
// Remove unregistered tokens from your database
if (unregisteredTokens.length > 0) {
console.log('Unregistered device token(s): ', unregisteredTokens.join(', '));
}
}).catch(error => console.log(error));
Dependencies
Contributions
This repo is based on previous work by kenble and eladnava.
Support
Please open an issue on this repo if you have any questions or need support.