# lesswork-pusher

> pusher service provider for lesswork-framework

Latest version **0.0.3** (published 2018-03-27) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install lesswork-pusher
pnpm add lesswork-pusher
yarn add lesswork-pusher
bun add lesswork-pusher
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2018-03-27 |
| First published | 2018-03-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 3.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | William Bowman |
| Maintainers | gcphost |

## Links

- npm: https://www.npmjs.com/package/lesswork-pusher
- Repository: https://github.com/lessworkjs/lesswork-pusher
- Homepage: https://github.com/lessworkjs/lesswork-pusher#readme
- Issues: https://github.com/lessworkjs/lesswork-pusher/issues
- npm.io page: https://npm.io/package/lesswork-pusher

## Dependencies (1)

- [pusher](https://npm.io/package/pusher.md) ^1.5.1

## Recent versions

- 0.0.3 (latest) — 2018-03-27
- 0.0.2 — 2018-03-27
- 0.0.1 — 2018-03-27

## README

# lesswork-pusher
This is a pusher provider for the `lesswork-framework`.

# Installation
```bash 
npm i --save lesswork-pusher
```

Register the provider and alias in your `config/app.js` file.

```js
const providers = [
  ...
  'lesswork-pusher/providers/PusherProvider',
];

const aliases = {
  ...
  Pusher: 'Lesswork/Pusher',
};
```

Create `config/pusher.js`
```js
module.exports = {
  appId: env('PUSHER_APP_ID'),
  key: env('PUSHER_APP_KEY'),
  secret: env('PUSHER_APP_SECRET'),
  cluster: env('PUSHER_APP_CLUSTER')
};
```

Define the `env` settings above in your `env.js`
```js
const env = {
  ...
  PUSHER_APP_ID: '',
  PUSHER_APP_KEY: '',
  PUSHER_APP_SECRET: '',
  PUSHER_APP_CLUSTER: '',
};
```


# Usage
See [pusher](https://www.npmjs.com/package/pusher) for full usage information.

```js
const Pusher = use('Pusher');

Pusher.trigger('channel-1', 'test_event', { message: "hello world" });
```

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