# @openovate/eventrpc

> Emit server events via HTTP and JSON RPC

Latest version **0.0.1** (published 2019-10-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @openovate/eventrpc
pnpm add @openovate/eventrpc
yarn add @openovate/eventrpc
bun add @openovate/eventrpc
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2019-10-21 |
| First published | 2019-10-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 24.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Christian Blanquera |
| Maintainers | cblanquera |
| Keywords | remote events, event rpc |

## Links

- npm: https://www.npmjs.com/package/@openovate/eventrpc
- npm.io page: https://npm.io/package/@openovate/eventrpc

## Dependencies (3)

- [shortid](https://npm.io/package/shortid.md) ^2.2.15
- [jsonrpc-lite](https://npm.io/package/jsonrpc-lite.md) ^2.0.7
- [@openovate/jsm](https://npm.io/package/@openovate/jsm.md) ^0.0.19

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 0.0.1 (latest) — 2019-10-21

## README

# Event RPC

Emit server events via HTTP and JSON RPC

## Install

```bash
$ npm i --save @openovate/eventrpc
```

## Usage

To use Event RPC, you will need to configure both the server and client.

### Server

The following shows how to setup an HTTP server using Event RPC.


```js
const eventrpc = require('@openovate/eventrpc');

//setup eventrpc
const events = eventrpc('/events');
events.on('api-call', (params) => { params.bar = 'foo' });

//setup server
const server = http.createServer(events);
server.listen(3000);
```

You can also separate the event listener and use it as a middleware like the following.

```js
const eventrpc = require('@openovate/eventrpc');

//setup events
const emitter = eventrpc.EventEmitter();
emitter.on('api-call', (params) => { params.bar = 'foo' });

//setup eventrpc
const events = eventrpc('/events');
events.use(emitter);

//setup server
const server = http.createServer(events);
server.listen(3000);
```

It is possible to use Event RPC with Express like the following.

```js
const express = require('express');
const eventrpc = require('@openovate/eventrpc');

//setup eventrpc
const events = eventrpc('/events');
events.on('api-call', (params) => { params.bar = 'foo' });

//setup express
const app = express();
app.use(events);

//setup server
const server = http.createServer(app);
server.listen(3000);
```

### Client

The following shows how to quickly setup the client side.

```js
<script type="text/javascript" src="/eventrpc/eventrpc.js"></script>
<script type="text/javascript">
const emit = eventrpc('http://localhost:3000/events', { fetch });
//http event call
const results = await emit('api-call', { foo: 'bar'});
</script>
```

It is possible to `require` Event RPC using webpack like the following.

```js
const eventrpc = require('eventrpc');
```

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