# jomiel-messages

> The javascript bindings for the jomiel protobuf messages.

Latest version **0.2.1** (published 2023-10-04) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install jomiel-messages
pnpm add jomiel-messages
yarn add jomiel-messages
bun add jomiel-messages
```

## Health

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

Positive: has types; no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2023-10-04 |
| First published | 2021-05-08 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 146.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Toni Gündoğdu |
| Maintainers | guendto |
| Keywords | jomiel, protobuf, messages |

## Links

- npm: https://www.npmjs.com/package/jomiel-messages
- Repository: https://github.com/guendto/jomiel-messages-js
- Homepage: https://github.com/guendto/jomiel-messages-js#readme
- Issues: https://github.com/guendto/jomiel-messages-js/issues
- npm.io page: https://npm.io/package/jomiel-messages

## Dependencies (1)

- [protobufjs](https://npm.io/package/protobufjs.md) ^7.2.5

## Recent versions

- 0.2.1 (latest) — 2023-10-04
- 0.2.0 — 2021-06-17
- 0.1.1 — 2021-05-08

## README

# jomiel-messages-js

[![npm-package](https://img.shields.io/npm/v/jomiel-messages?color=%230a66dc)][npm]
[![code-style](https://img.shields.io/badge/code%20style-prettier+eslint-%230a66dc)][prettier-eslint]

The javascript bindings for the [jomiel] protobuf messages.

- Easy to install [jomiel] protobuf message bindings for js
- Generated from the [jomiel-proto] declarations

[prettier-eslint]: http://npm.im/prettier-eslint
[npm]: https://npm.im/jomiel-messages
[jomiel]: https://github.com/guendto/jomiel

## Installation

```shell
npm install jomiel-messages
```

## Usage

Serialize an inquiry message:

```javascript
import jomielMessages from "jomiel-messages";

const { Inquiry } = jomielMessages.jomiel.protobuf.v1beta1;
const uri = "https://...";

const msg = Inquiry.create({ media: { inputUri: uri } });
const bytes = Inquiry.encode(msg).finish();

// ...
```

Deserialize the response message:

```javascript
const { Response, StatusCode } = jomielMessages.jomiel.protobuf.v1beta1;

// bytes: data read from the zeromq socket (returned by jomiel)
const msg = Response.decode(bytes);

if (msg.status.code !== StatusCode.STATUS_CODE_OK) {
  const status = msg.status;
  // ...
}
```

## License

`jomiel-messages` is licensed under the [Apache License version
2.0][aplv2].

[aplv2]: https://www.tldrlegal.com/l/apache2

## Acknowledgements

### Subprojects (git-subtree)

- [src/jomiel-proto/](src/jomiel-proto/) of [jomiel-proto]

[jomiel-proto]: https://github.com/guendto/jomiel-proto/

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