# chimera-js-integrator

> Communication Extension for JS to ChimeraPy's Pythonic Runtime Environment

Latest version **0.0.7** (published 2023-03-08) · GPL-3.0-or-later license · 0 weekly downloads

## Install

```sh
npm install chimera-js-integrator
pnpm add chimera-js-integrator
yarn add chimera-js-integrator
bun add chimera-js-integrator
```

## 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.7 |
| Published | 2023-03-08 |
| First published | 2023-02-02 |
| Weekly downloads | 0 |
| License | GPL-3.0-or-later |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 73 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Eduardo Davalos |
| Maintainers | edavalosanaya |
| Keywords | communication, ChimeraPy, data, analysis |

## Links

- npm: https://www.npmjs.com/package/chimera-js-integrator
- Repository: https://github.com/oele-isis-vanderbilt/ChimeraJS
- Homepage: https://github.com/oele-isis-vanderbilt/ChimeraJS#readme
- Issues: https://github.com/oele-isis-vanderbilt/ChimeraJS/issues
- npm.io page: https://npm.io/package/chimera-js-integrator

## Dependencies (6)

- [ws](https://npm.io/package/ws.md) ^8.12.1
- [mitt](https://npm.io/package/mitt.md) ^3.0.0
- [js-logger](https://npm.io/package/js-logger.md) ^1.6.1
- [typescript](https://npm.io/package/typescript.md) ^4.9.4
- [isomorphic-ws](https://npm.io/package/isomorphic-ws.md) ^5.0.0
- [datastructures-js](https://npm.io/package/datastructures-js.md) ^12.0.0

## Alternatives

- [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads
- [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads
- [masked](https://npm.io/package/masked.md) — 5.5K weekly downloads
- [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads
- [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads

## Recent versions

- 0.0.7 (latest) — 2023-03-08
- 0.0.6 — 2023-02-28
- 0.0.5 — 2023-02-28
- 0.0.4 — 2023-02-28
- 0.0.3 — 2023-02-09
- 0.0.2 — 2023-02-02
- 0.0.1 — 2023-02-02

## README

# ChimeraJS Integrator

![tests](https://img.shields.io/github/actions/workflow/status/oele-isis-vanderbilt/ChimeraJS/test.yml)
[![npm](https://img.shields.io/npm/v/chimera-js-integrator)](https://npmjs.com/package/chimera-js-integrator)
![license](https://img.shields.io/github/license/oele-isis-vanderbilt/ChimeraJS)

Communication Extension for JS to ChimeraPy's Pythonic Runtime Environment using ZeroMQ

![Architecture Diagram](./docs/_static/ChimeraJS.drawio.png)

## Installation

Use the following command to install the package:

```bash
npm install chimera-js-integrator
```

## Usage

First, you need to install the plugin to your Vue application. Use the following to start:

```js
import { ChimeraJSIntegrator } from 'chimera-js-integrator'
import mitt from 'mitt'

// Create the emitter
const emitter = mitt()

// Install plugin (provide the emitter instance from mitt)
// You can also omit the eventArray parameter if you can to
// capture all events and broadcast
const chimerajs = new ChimeraJSIntegrator(emitter, ['event1', 'event1'], 6767)

```

### Option Parameters

| Parameter  | Type         | Accepted or Example inputs | Required | Description                                                                                                                                  |
|------------|--------------|----------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------|
| emitter    | mitt.Emitter | mitt()                     | True     | The emitter used to communicate between the JS application and ChimeraPy cluster                                                             |
| eventArray | string[]     | ['event1', 'event2'] or [] | False    | Provide an array of events to listen and distribute. [] implies that all events will be broadcast. BEWARE: avoid broadcasting sensitive data |
| wsPort     | number       | 6767 | False    | The port the integrator will bind to the ChimeraPy Cluster's WS Server (the WSS's port)                                                                |

## Example

TODO

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