npmpackage.info

Gathering detailed insights and metrics for rockets-client

Other packages similar to rockets-client

rockets

1.2.4

Server-side client for rockets/rockets

rocket-launch-live-client

1.0.3

A Node.JS client for interacting with the RocketLaunch.Live API

rockets-slack

1.0.1

Slack integration client for rockets/rockets

@rocketsoftware/eureka-js-client

4.5.9

A JavaScript implementation the Netflix OSS service registry, Eureka.

Gathering detailed insights and metrics for rockets-client

rockets-client - 1.0.0 | npmpackage.info

rockets-client

REST and websockets C++ library

1.0.0

LGPL-3.0

C++

305.89 kB

Installations

npm install rockets-client

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>= 7.9

Node Version

8.15.0

NPM Version

6.4.1 Pull Requests

Open

19

Total

110

Closed

30

Merged

61

Issues

Open

3

Total

7

Closed

4

Releases

1.0.0

Updated on Jan 18, 2019

View All 1 releases

Languages

C++

TypeScript

Python

CMake

Makefile

JavaScript

Shell

C++ (82.67%)

TypeScript (10.69%)

Python (5.39%)

CMake (0.67%)

Makefile (0.29%)

JavaScript (0.22%)

Shell (0.07%)

Developer

BlueBrain

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

LGPL-3.0 License

38 Stars

115 Commits

9 Forks

13 Watchers

37 Branches

17 Contributors

Updated on Aug 19, 2024

Maintainers

View All 17 Contributors

Package Meta Information

Latest Version

1.0.0

Package Id

rockets-client@1.0.0

Unpacked Size

305.89 kB

Size

71.11 kB

File Count

NPM Version

6.4.1

Node Version

8.15.0

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Rockets JS Client

A small client for Rockets using JSON RPC as communication contract over a WebSocket.

Installation
Usage
Release
Learning Material

Installation

You can install this package from NPM:

1npm add rxjs rockets-client

Or with Yarn:

1yarn add rxjs rockets-client

CDN

For CDN, you can use unpkg:

https://unpkg.com/rockets-client/dist/bundles/rockets-client.umd.min.js

The global namespace for rockets is rocketsClient:

1const {Client} = rocketsClient;
2
3const rockets = new Client({
4    url: 'myhost'
5});

Usage

Connection

Create a client and connect:

1import {Client} from 'rockets-client';
2
3const rockets = new Client({
4    url: 'myhost',
5    onConnected() {
6        console.info('I just connected');
7    },
8    onClosed(evt) {
9        console.log(`Socket connection closed with code ${evt.code}`);
10    }
11});

Close the connection with the socket cleanly:

1import {Client} from 'rockets-client';
2
3const rockets = new Client({url: 'myhost'});
4
5rockets.subscribe({
6    next(notification) {
7        console.log(notification);
8    },
9    complete() {
10        console.log('Socket connection closed');
11    }
12});
13
14rockets.disconnect();

Notifications

Listen to server notifications:

1import {Client} from 'rockets-client';
2
3const rockets = new Client({url: 'myhost'});
4
5rockets.subscribe(notification => {
6    console.log(notification);
7});

Send notifications:

1import {Client} from 'rockets-client';
2
3const rockets = new Client({url: 'myhost'});
4
5rockets.notify('mymethod', {
6    ping: true
7});

Send a notification using the Notification object:

1import {Client, Notification} from 'rockets-client';
2
3const rockets = new Client({url: 'myhost'});
4
5const notification = new Notification('mymethod', {
6    ping: true
7});
8rockets.notify(notification);

Requests

Make a request:

1import {Client} from 'rockets-client';
2
3const rockets = new Client({url: 'myhost'});
4
5const response = await rockets.request('mymethod', {
6    ping: true
7});
8console.log(response);

NOTE: There is no need to wait for a connection to be established with the socket as requests will be buffered and sent once the connection is alive. In case of a socket error, the request promise will reject. The same is true for batch requests and notifications.

Or make a request using the Request object:

1import {Client, Request} from 'rockets-client';
2
3const rockets = new Client({url: 'myhost'});
4
5const request = new Request('mymethod', {
6    ping: true
7});
8const response = await rockets.request(request);
9console.log(response);

Handle a request error:

1import {Client} from 'rockets-client';
2
3const rockets = new Client({url: 'myhost'});
4
5try {
6    await rockets.request('mymethod');
7} catch (err) {
8    console.log(err.code);
9    console.log(err.message);
10    console.log(err.data);
11}

NOTE: Any error that may occur will be a JsonRpcError.

Cancel a request:

1import {Client} from 'rockets-client';
2
3const rockets = new Client({url: 'myhost'});
4
5const task = rockets.request('mymethod');
6task.cancel();

Get progress updates for a request:

1import {Client} from 'rockets-client';
2
3const rockets = new Client({url: 'myhost'});
4
5const task = rockets.request('mymethod');
6task.on('progress')
7    .subscribe(progress => {
8        console.log(progress);
9    });

Batching

Make a batch request:

1import {Client, Notification, Request} from 'rockets-client';
2
3const rockets = new Client({url: 'myhost'});
4
5const request = new Request('mymethod');
6const notification = new Notification('mymethod');
7const [response] = await rockets.batch(...[
8    request,
9    notification
10]);
11
12const result = await response.json();
13console.log(result);

NOTE: Notifications will not return any responses and if no requests are sent, the batch request will resolve without any arguments.

Handle a batch request error:

1import {Client} from 'rockets-client';
2
3const rockets = new Client({url: 'myhost'});
4
5try {
6    const request = new Request('mymethod');
7    await rockets.batch(request);
8} catch (err) {
9    console.log(err.code);
10    console.log(err.message);
11    console.log(err.data);
12}

NOTE: The batch promise will not reject for response errors, but you can catch the response error when using the response .json() method:

1import {Client} from 'rockets-client';
2
3const rockets = new Client({url: 'myhost'});
4
5try {
6    const request = new Request('mymethod');
7    const [response] = await rockets.batch(request);
8    await response.json();
9} catch (err) {
10    console.log(err.code);
11    console.log(err.message);
12    console.log(err.data);
13}

Cancel a batch request:

1import {Client} from 'rockets-client';
2
3const rockets = new Client({url: 'myhost'});
4
5const request = new Request('mymethod');
6const task = rockets.batch(request);
7
8task.cancel();

NOTE: Notifications cannot be canceled.

Get progress updates for a batch request:

1import {Client} from 'rockets-client';
2
3const rockets = new Client({url: 'myhost'});
4
5const request = new Request('mymethod');
6const task = rockets.batch(request);
7
8task.on('progress')
9    .subscribe(progress => {
10        console.log(progress);
11    });

Release

If you're a contributor and wish to make a release of this package use:

1# Cut a minor release
2# A release can be: patch, minor, major;
3yarn release --release-as minor

See release as a target type imperatively like npm-version for more release options.

After the changes land in master, the new version will be automatically published by the CI.

IMPORTANT: Follow the semver for versioning.

Learning Material

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

7

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

93 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2
Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-vfrc-7r7c-w9mx
Warn: Project is vulnerable to: GHSA-7wwv-vh3v-89cq
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-xf5p-87ch-gxw2
Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3
Warn: Project is vulnerable to: GHSA-f9cm-qmx5-m98h
Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-7xcx-6wjh-7xp2
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
Warn: Project is vulnerable to: GHSA-46c4-8wrp-j99v
Warn: Project is vulnerable to: GHSA-9m6j-fcg5-2442
Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc
Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Warn: Project is vulnerable to: PYSEC-2021-95 / GHSA-8ch4-58qp-g3mp

Score

3

/10

Last Scanned on 2025-07-14

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to rockets-client

Other packages similar to rockets-client

rockets-client

Installations

Developer Guide

No

CommonJS

>= 7.9

8.15.0

6.4.1

Pull Requests

19

110

30

61

Issues

3

7

4

Releases

Languages

Developer

BlueBrain

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

Rockets JS Client

Table of Contents

Installation

CDN

Usage

Connection

Notifications

Requests

Batching

Release

Learning Material

10

10

7

0

0

0

0

0

0

3

/10