https://github.com/hyperlink/pushover
Pushover.net client written in TypeScript
https://github.com/hyperlink/pushover
Last synced: over 1 year ago
JSON representation
Pushover.net client written in TypeScript
- Host: GitHub
- URL: https://github.com/hyperlink/pushover
- Owner: hyperlink
- License: mit
- Created: 2021-08-17T01:03:50.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-08-17T01:31:15.000Z (almost 5 years ago)
- Last Synced: 2025-01-24T07:31:07.345Z (over 1 year ago)
- Language: TypeScript
- Size: 8.79 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pushover Client
A simple lightweight client for Pushover notifications.
# Installation
```bash
npm install @hyperlink/pushover
```
# Usage
```typescript
import { Pushover } from '@hyperlink/pushover';
async function sendMessage() {
const pushover = new Pushover('', '');
await pushover.sendMessage({
message: 'Test message',
title: 'Test title',
});
}
sendMessage();
```
### Message Format
```typeScript
interface PushoverMessage {
message: string;
title?: string;
sound?: string;
device?: string;
priority?: number;
url?: string;
url_title?: string;
attachment?: string; // path to the file
timestamp?: string;
}
```