Package Exports
- fcm-http2
- fcm-http2/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-http2) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
fcm-http2
Library in typescript for sending multicast notifications using HTTP/2 multiplexing and the FCM HTTP v1 API.
Features supported by fcm-http2:
- 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-http2
Once the library has been installed you can start using it in this way:
// FCM library recovery
import { FCM } from 'src/lib/fcm';
import { FcmOptions } from 'src/entity/fcm-options';
// Init FCM with default options
// NOTE: Put the service-account.json file in the package's lib directory
const fcmClient = new FCM();
// Or you can specify 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: require('./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"
}
};
// 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));
Requirements
- Node.js >= 12
Contributions
Thanks to eladnava for contributing to the source code base of this library.
Support
For any doubts open an issue or contact this email fctaddia@duck.com