Gathering detailed insights and metrics for node-nats-streaming-buffered-client
Gathering detailed insights and metrics for node-nats-streaming-buffered-client
Buffered client for NATS node.js client
Installations
npm install node-nats-streaming-buffered-clientDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Min. Node Version
>=6.0.0
Node Version
8.9.1
NPM Version
6.9.0
Releases
25
Languages
2
TypeScript
JavaScript
TypeScript (85.43%)
JavaScript (14.57%)
Developer
springtree
Download Statistics
Total Downloads
6,149
Last Day
7
Last Week
71
Last Month
102
Last Year
741
GitHub Statistics
MIT License
1 Stars
83 Commits
1 Forks
3 Watchers
20 Branches
2 Contributors
Updated on Jun 09, 2021
Maintainers
1
Package Meta Information
Latest Version
1.6.0
Package Id
node-nats-streaming-buffered-client@1.6.0
Unpacked Size
43.21 kB
Size
11.05 kB
File Count
6
NPM Version
6.9.0
Node Version
8.9.1
Total Downloads
Cumulative downloads
Total Downloads
6,149
Last Day
250%
7
Compared to previous day
Last Week
3,450%
71
Compared to previous week
Last Month
24.4%
102
Compared to previous month
Last Year
106.4%
741
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Peer Dependencies
1
Dev Dependencies
29
@commitlint/cli@commitlint/config-angular@types/jest@types/nodeavacolorscoverallscross-envhuskylint-stagedlodash.camelcasenode-nats-streamingnycpromptreplace-in-filerimrafrolluprollup-plugin-commonjsrollup-plugin-jsonrollup-plugin-node-resolverollup-plugin-sourcemapsrollup-plugin-typescript2semantic-releasets-nodetslinttslint-config-standardtypedoctypescriptvalidate-commit-msg
NATS Streaming Buffered Client
This is a client for the NATS streaming server built for clients that may have an intermittent connection to the server. The need for this client arose for IoT devices with 4G connections and to ensure no messages are lost on server upgrades, reboots or mishaps.
Features
- Reconnect logic
- Ring buffer to store messages to publish
- Retry to publish messages
Usage
1npm install node-nats-streaming-buffered-client
You can import the buffered client class after installing it with npm:
1import { NatsBufferedClient } from 'node-nats-streaming-buffered-client' 2 3// Initialize a client with a buffer of 2000 messages 4// The default reconnect timeout is 30s but can be changed 5// 6// You can instruct the client to wait for the initial connect to succeed before 7// allowing any kind of publishing. 8// 9// You can also provide an alternate logger if you want to use something 10// like bunyan. The same interface as console is asumed 11// 12const bufferSize = 2000; 13const waitForInitialConnect = false; 14const logger = console; 15 16// NOTE: constructor parameters have changed in v0.3.0 17// 18const client = new NatsBufferedClient( bufferSize, waitForInitialConnect, logger ); 19 20// Connect to the NATS server 21// NATS connect options: https://github.com/nats-io/node-nats#connect-options 22// 23const natsOptions = { ... }; 24client.connect( 'test-cluster', 'test', natsOptions ); 25 26// Add a message to the buffer for publishing 27// 28client.publish( 'my-channel', { content: 'stuff' } ); 29 30// Access to NATS Streaming client instance is available 31// 32const subscription = client.stan.subscribe( 'topic', ... );
There is a more complete test client here
A note on nats connect options
The reconnect logic from the nats streaming client relies on these 3 options:
1const defaultOptions = { 2 maxReconnectAttempts: -1, 3 reconnect: true, 4 waitOnFirstConnect: true, 5};
Be very careful when supplying your own connect options to not change these unless you know what you're doing.
Forced reconnects and subscriptions
If the client loses connection with the nats streaming server long enough the server will decide to remove the client. The lower level nats layer will reconnect when a connection is restored but publishing will fail becuase the client is not known on the server. A forced reconnect will be triggered by the buffered client when this occurs. This will re-register the client with the server and publishing will resume.
If you have also created subscriptions these will not resume receiving events because the subscription state will also have been purged on the server. The buffered client will emit a trio of events during a forced reconnect which can be used to resubscribe. These events are:
- forced_reconnecting
- forced_disconnected
- forced_reconnected
To prevent memory leaks be sure to call removeAllListeners on your old subscription(s).
The forced_reconnected event is a good trigger to begin resubscribing.
NPM scripts
npm run test: Run test suitenpm run build: Generate bundles and typings, create docs
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
Found 0/18 approved changesets -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 12 are checked with a SAST tool
Reason
74 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-rmvr-2pp2-xj38
- Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
- 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-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- 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-ww39-953v-wcq6
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- 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-rc47-6667-2j5j
- Warn: Project is vulnerable to: GHSA-x55w-vjjp-222r
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-gxr4-xjj5-5px2
- Warn: Project is vulnerable to: GHSA-jpcq-cgw6-v4j6
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- 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-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-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-w7rc-rwvf-8q5r
- Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
- Warn: Project is vulnerable to: GHSA-93f3-23rq-pjfp
- Warn: Project is vulnerable to: GHSA-jmqm-f2gx-4fjv
- Warn: Project is vulnerable to: GHSA-pw54-mh39-w3hc
- Warn: Project is vulnerable to: GHSA-xgh6-85xh-479p
- 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-r2j6-p67h-q639
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx
- Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch
- Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
- Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
- Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
- 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-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-cf4h-3jhx-xvhq
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
- Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Score
1.7
/10
Last Scanned on 2025-07-07
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