Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bjarneo/pushover-promise
Pushover.net API. Currently supporting Message API.
https://github.com/bjarneo/pushover-promise
Last synced: 3 days ago
JSON representation
Pushover.net API. Currently supporting Message API.
- Host: GitHub
- URL: https://github.com/bjarneo/pushover-promise
- Owner: bjarneo
- License: mit
- Created: 2016-04-21T18:08:36.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-06-26T03:49:41.000Z (over 2 years ago)
- Last Synced: 2024-10-13T15:42:35.959Z (about 1 month ago)
- Language: JavaScript
- Size: 5.86 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
pushover-promise
======
Pushover.net API promise wrapper.
Currently supporting only the message API.
Installation
------
It's available on npm.
```
npm install --save pushover-promise
```
API Documentation
------
* [https://pushover.net/api](https://pushover.net/api)
Usage
------
Basic
```js
import { Message } from 'pushover-promise';
// or
const Message = require('pushover-promise').Message;
const user = 'user';
const token = 'token';
const msg = new Message(user, token);
msg.push('Pushover message API is now as a promise')
.then(console.log)
.catch(console.error);
```
All included
```js
const Message = require('pushover-promise').Message;
const user = 'user';
const token = 'token';
const msg = new Message(user, token);
msg.push('Pushover message API is now as a promise', {
title: 'Check out my package', // Optional
url: 'http://www.npmjs.com/package/pushover-promise', // Optional
url_title: 'package: pushover-promise', // Optional
priority: 2, // Optional
retry: 30, // Optional
expire: 120 // Optional
})
.then(console.log)
.catch(console.error);
```
Missing pieces
------
* [https://pushover.net/api#verification](https://pushover.net/api#verification)
* [https://pushover.net/api#receipt](https://pushover.net/api#receipt)
* [https://pushover.net/api/subscriptions](https://pushover.net/api/subscriptions)
* [https://pushover.net/api/groups](https://pushover.net/api/groups)
* [https://pushover.net/api/licensing](https://pushover.net/api/licensing)
* [https://pushover.net/api/client](https://pushover.net/api/client)
Tests
------
```bash
$ npm test
```
Contribution
------
Contributions are appreciated.
License
------
MIT-licensed. See LICENSE.