# prowljs

> Node library for accessing Prowl

Latest version **1.0.1** (published 2017-07-10) · CC-BY-NC-SA-4.0 license · 0 weekly downloads

## Install

```sh
npm install prowljs
pnpm add prowljs
yarn add prowljs
bun add prowljs
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2017-07-10 |
| First published | 2017-07-10 |
| Weekly downloads | 0 |
| License | CC-BY-NC-SA-4.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Johannes Zinnau |
| Maintainers | johannes85 |

## Links

- npm: https://www.npmjs.com/package/prowljs
- Repository: https://github.com/johannes85/prowljs
- Homepage: https://github.com/johannes85/prowljs#readme
- Issues: https://github.com/johannes85/prowljs/issues
- npm.io page: https://npm.io/package/prowljs

## Dependencies (2)

- [xml2js](https://npm.io/package/xml2js.md) ^0.4.17
- [request](https://npm.io/package/request.md) ^2.81.0

## Recent versions

- 1.0.1 (latest) — 2017-07-10

## README

## Node.js Library for Accessing Prowl

This library supports all API endpoints provided by Prowl:
  * add
  * verify
  * retrieve/token
  * retrieve/apikey

It's written in TypeScript and is optimized for using async and await.

### Example in TypeScript with async await
```typescript
import Prowl, { IAddResult, Priority } from 'prowljs';

(async () => {
  let p = new Prowl();
  try {
    let addResult: IAddResult = await p.add({
      apiKey: '...',
      application: 'TestApp',
      event: 'Test',
      description: 'Test App Description',
      priority: Priority.Emergency,
      url: 'http://www.foo.bar'
    });
    console.log(addResult);
  } catch (error) {
    console.error(error);
  }
})();
```

### Example in JavaScript with Promises
```javascript
const prowl = require('prowljs');

let p = new prowl.default();
p.add({
  apiKey: '...',
  application: 'TestApp',
  event: 'Test',
  description: 'Test App Description',
  priority: prowl.Priority.Emergency,
  url: 'http://www.foo.bar'
}).then((addResult) => {
  console.log(addResult);
}).catch((error) => {
  console.error(error);
});
```

---
_Source: https://npm.io/package/prowljs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._