2.3.5 • Published 4 months ago

fcm-http2 v2.3.5

Weekly downloads
-
License
Apache-2.0
Repository
gitlab
Last release
4 months ago

fcm-http2

npm version license

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

Installation

Use package manager npm to install fcm-http2.

npm i fcm-http2

Usage

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.

License

Apache License 2.0

Support

For any doubts open an issue or contact this email fctaddia@duck.com

2.3.5

4 months ago

2.3.4

7 months ago

2.3.3

9 months ago

2.3.0

10 months ago

2.2.1

10 months ago

2.2.0

10 months ago

2.3.2

10 months ago

2.3.1

10 months ago

2.2.2

10 months ago

2.1.6

11 months ago

2.1.2

1 year ago

2.1.1

1 year ago

2.1.4

1 year ago

2.1.3

1 year ago

2.0.7

1 year ago

2.1.5

12 months ago

2.0.6

1 year ago

2.1.0

1 year ago

2.0.5

1 year ago

2.0.4

1 year ago

2.0.3

1 year ago

2.0.2

1 year ago

2.0.1

1 year ago

2.0.0

1 year ago

1.0.1

2 years ago

1.0.0

2 years ago