# quark-engine

> Quark Engine Client lib for NodeJS

Latest version **1.0.0** (published 2020-08-10) · 0 weekly downloads

## Install

```sh
npm install quark-engine
pnpm add quark-engine
yarn add quark-engine
bun add quark-engine
```

## 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.0.0 |
| Published | 2020-08-10 |
| First published | 2020-08-10 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 79.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Green Screens Ltd. |
| Maintainers | greenscreens-io |

## Links

- npm: https://www.npmjs.com/package/quark-engine
- npm.io page: https://npm.io/package/quark-engine

## Dependencies (3)

- [ws](https://npm.io/package/ws.md) *
- [node-fetch](https://npm.io/package/node-fetch.md) *
- [wasm-flate](https://npm.io/package/wasm-flate.md) *

## Recent versions

- 1.0.0 (latest) — 2020-08-10

## README

# [Quark Engine for NodeJS](https://www.greenscreens.io/quark).

Visit project web page [here](https://www.greenscreens.io/quark).

This is client library for NodeJS enabling communication with Green Screens Quark Engine for Java.

Use it to call remote Java services based on Quark Engine methodology.

Calls are the same as for browser API's, engine will dynamically generate API calls to be used across NodeJS app.

Upon initialization with

```
const QuarkEngine = require('./lib/engine');

const channelWeb = "http://localhost:8080/io.greenscreens.quark/api";
const channelWS = "ws://localhost:8080/io.greenscreens.quark/socket";

let Engine = new QuarkEngine({api:channelWeb, service: channelWS});
await Engine.init();
```

Use the following to get generated API, or attach it to the global object.
**io** is first part of namespace group defined in Java server side controllers.
```
const { io } = Engine.api();
global.io = io;
```

Multi-service is supported also. Simply initialize another Engine instance.

### Install

1. Download or clone repository
2. execute **npm install** to install dependencies
3. Start Java demo web app  from quark-engine repo
4. execute node test.js


**NOTE:** WebCrypto wrapper for NodeJs copied from link below as module is not in npm. Lib is used to wrap NodeJS crypto API into WebCrypto API for compatibility purposes.
https://github.com/nodejs/webcrypto

© Green Screens Ltd. 2016 - 2020

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