# @p4d/hermes-nodejs

> Hermes messaging library - server version

Latest version **1.4.0** (published 2017-09-12) · WTFPL license · 0 weekly downloads

## Install

```sh
npm install @p4d/hermes-nodejs
pnpm add @p4d/hermes-nodejs
yarn add @p4d/hermes-nodejs
bun add @p4d/hermes-nodejs
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.0 |
| Published | 2017-09-12 |
| First published | 2017-04-19 |
| Weekly downloads | 0 |
| License | WTFPL |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Tomás Migone |
| Maintainers | javougarte, shipupi, tmigone, p4d-owner |
| Keywords | hermes |

## Links

- npm: https://www.npmjs.com/package/@p4d/hermes-nodejs
- npm.io page: https://npm.io/package/@p4d/hermes-nodejs

## Dependencies (2)

- [@p4d/rpi](https://npm.io/package/@p4d/rpi.md) ^1.7.2
- [socket.io-client](https://npm.io/package/socket.io-client.md) ^1.7.3

## Recent versions

- 1.4.0 (latest) — 2017-09-12
- 1.3.0 — 2017-08-18
- 1.2.1 — 2017-04-19
- 1.2.0 — 2017-04-19
- 1.1.0 — 2017-04-19

## README

# Hermes NodeJS Package

## Description

Small NPM package that forwards event messages to the queue server ([RPi-Queue](https://www.npmjs.com/package/@p4d/rpi-queue)) through a socket server on port 9999.

## Installation

```bash
npm install --save @p4d/hermes-nodejs
```

## Usage
### Require package
```javascript
	const Hermes = require('@p4d/hermes-nodejs')
```
### Create hermes object
```javascript
	// Specifying configuration
	var hermes = new Hermes({
		type: 'testAppData',
		project: {
			id: 'test_project',
			name: 'Test Project'
		},
		kronosId: 'abc123'
	})

	// Using default RPi information (Requires properly configured Raspberry Pi)
	var hermes = new Hermes({
		type: 'testAppData'
	})
```
To configure RPi use [rpi-config](https://www.npmjs.com/package/@p4d/rpi-config).

### Send events
```javascript
	hermes.send(data)
```
Where data is a JSON object.

## Full example

```javascript
	const Hermes = require('@p4d/hermes-nodejs')

	var hermes = new Hermes({
		type: 'testAppData',
		project: {
			id: 'test_project',
			name: 'Test Project'
		},
		kronosId: 'abc123'
	})
	var data = {
		name: 'new_experience',
		experience_id: 2
	}
	hermes.send(data)
```

## Limitations

This module requires that the queue server is correctly configured. It does not send messages on it's own. For documentation on the queue server see: [RPi-Queue](https://www.npmjs.com/package/@p4d/rpi-queue)

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