Skip to content

Latest commit

 

History

History
47 lines (36 loc) · 1.91 KB

README.md

File metadata and controls

47 lines (36 loc) · 1.91 KB

NATS Node Transport - A NATS client for Node.Js

A Node.js transport for the NATS messaging system.

GitHub License NATS.js CI NPM Version NPM Downloads NPM Downloads

This module implements a Node.js native TCP transport for NATS. This library re-exports NATS core library which implements all basic NATS client functionality. This library is compatible with Bun.

Installation

npm install @nats-io/transport-node
# or
bun install @nats-io/transport-node

You can then import the connect function to connect using the node transport like this:

import { connect } from "@nats-io/transport-node";

To use NATS JetStream, NATS KV, NATS Object Store, or the NATS Services functionality you'll need to install the desired modules as described in each of the modules README files.

This module simply exports a connect() function that returns a NatsConnection supported by a Nodejs TCP socket. This library re-exports all the public APIs for the core module. Please visit the core module for examples on how to use a connection or refer to the JSDoc documentation.

Supported Node Versions

Our support policy for Nodejs versions follows Nodejs release support. We will support and build node-nats on even-numbered Nodejs versions that are current or in LTS.