# arunacore-api

> ArunaCore is an open source websocket server made with nodejs for intercomunication between applications.

Latest version **1.0.0-BETA.8** (published 2026-10-02) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install arunacore-api
pnpm add arunacore-api
yarn add arunacore-api
bun add arunacore-api
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 1.0.0-BETA.8 |
| Published | 2026-10-02 |
| First published | 2022-06-05 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=20.11.1 |
| Dependencies | 2 |
| Unpacked size | 96.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 0 |
| Author | Hugo Heger |
| Maintainers | lobometalurgico |
| Keywords | management, aruna, websocket, api |

## Links

- npm: https://www.npmjs.com/package/arunacore-api
- Repository: https://github.com/ArunaBot/ArunaCore-js-api
- Homepage: https://github.com/ArunaBot/ArunaCore-js-api#readme
- Issues: https://github.com/ArunaBot/ArunaCore-js-api/issues
- npm.io page: https://npm.io/package/arunacore-api

## Dependencies (2)

- [ws](https://npm.io/package/ws.md) 8.22.0
- [@promisepending/logger.js](https://npm.io/package/@promisepending/logger.js.md) 1.1.3

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.0.0-BETA.8 (latest) — 2026-10-02
- 1.0.0-ALPHA.2 (alpha) — 2022-06-05
- 1.0.0-BETA.7 — 2026-02-15
- 1.0.0-BETA.6 — 2026-02-15
- 1.0.0-BETA.5 — 2025-11-03
- 1.0.0-BETA.4 — 2025-11-02
- 1.0.0-BETA.3 — 2025-06-02
- 1.0.0-BETA.2 — 2025-05-31
- 1.0.0-BETA.1 — 2025-05-14
- 1.0.0-BETA.0 — 2024-01-02
- 1.0.0-ALPHA.5 — 2023-03-26
- 1.0.0-ALPHA.4 — 2022-12-18
- 1.0.0-ALPHA.3 — 2022-07-06
- 1.0.0-ALPHA.0 — 2022-06-05

## README

# ArunaCore - JavaScript API

## Introduction

ArunaCore is a framework that helps developers to build their own applications.

with it is ease to create and manange a new application created from scratch or to use on top of existing application.

It uses websocket to communicate with your application and it is easy to use.

## The API

### Installing:

To install, just use `npm install arunacore-api`or `yarn add arunacore-api`.

### Creating a client:

```js
import { ArunaClient } from 'arunacore-api';

const client = new ArunaClient('localhost', 3000, '<clientName>');

client.connect();
```

### Receiving a message:

The message is received as a JSON object with parsed informations.

```js
client.on('message', (message) => {
  console.log(message);
});
```

### The full documentation:

Because it is still in beta, we do not have formal and complete documentation. Although it can already be used in production, we recommend waiting until version 1.0.0 is released.

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