README.md

OneSignal Nodejs Notification api wrapper

This is an unofficial wrapper/client for the OneSignal notification API that runs on Node.JS. A list of selected wrappers for different languages and environments is available at the Developer site's Libraries page.

Installation

$ npm install @palmabit/onesignal-notification

Usage

const OnesignalNotificationApi = require('@palmabit/onesignal-notification')
const oneSignal = new OnesignalNotificationApi('MY-REST-KEY', 'APP-ID')

const message = {
  it: 'Some message',
  en: 'Some message'
}

oneSignal.sendToAll(message, null, null, (err, res) => {
  console.log(err)
  console.log(res)
})

API

sendToAll

const OnesignalNotificationApi = require('@palmabit/onesignal-notification')
const oneSignal = new OnesignalNotificationApi('MY-REST-KEY', 'APP-ID')
oneSignal.sendToAll(message, options, action, (err, res) => {
  console.log(err)
  console.log(res)
})

sendToSegment

const OnesignalNotificationApi = require('@palmabit/onesignal-notification')
const oneSignal = new OnesignalNotificationApi('MY-REST-KEY', 'APP-ID')
oneSignal.sendToSegments(message, ['segment1', 'segment2], (err, res) => {
  console.log(err)
  console.log(res)
})

sendToDevices

//Coming Soon

...

Test

npm test

Coverage

npm run coverage

Development

See something you think can be improved? Open an issue or clone the project and send a pull request with your changes.

Author

Palmabit

License

MIT license