primus-requests/README.md

Send named requests and receive responses with primus

# Primus Requests

Send a named request with data and attach a callback to get the response.

## Installation

```bash
npm install primus-requests --save
```

After installing with npm add primus-requests as a [primus plugin](https://github.com/primus/primus#plugins)

```
{
    transformer: ...,
    plugin: {
        requests: require('primus-requests')
    }
}
```

## Usage

Sending requests is identical on the server and the client.

### `send(name, [data, callback])`

```
(primus || spark).send('message', 'hello', (data) => {

    // Do something with the response in data

})
```

### `on(name, handler)`

Responding to requests is also identical on the server and client.

```
(primus || spark).on('hello', (data, response) => {

    // Data is what is sent with the request

    // Response is a callback to send data back
    response('Well hey there')

})
```