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

node-onesignal

v0.3.1

Published

Node wrapper for the One Signal API

Downloads

50

Readme

OneSignal SDK for Node.js Build Status

This is an unofficial Node.js SDK for the OneSignal Push Notification Service, which wraps their REST API.

Basic Usage

// require the module
const OneSignalClient = require('node-onesignal');

// create a new clinet
const client = new OneSignalClient([YOUR APP ID], [YOUR REST API KEY]);

// send a notification
client.sendNotification('test notification', {
    included_segments: 'all'
});

API

OneSignalClient(appId, restApiKey)

  • appId(string, required) - your OneSignal App ID

  • restApiKey(string, required) - your OneSignal REST API Key

sendNotification(message, options)

  • message(string/object, required) - the content of your message. Note: when passing an object, please see the OneSignal documentation for details on the format.

  • options(object) - OneSignal options. Please see the OneSignal documentation.

As you can see, this SDK does not implement all of the methods available through the OneSignal REST API. If there are other methods you require, please open an issue or feel free to create a PR (with tests!).

Contributing

Just open a PR and include tests. Any help is greatly appreciated!