0.4.2 • Published 12 months ago
@sndo/nats-nest v0.4.2
nats-nest
nats-nest is a thin wrapper around an embedded NATS server in a Go module. A server can be started through the command-line or using the NatsServer class, which basically just invokes the nats-server executable.
Installation
npm install @sndo/nats-nestCLI Usage
A NATS server can be started like so:
npx nats-nestNatsServer Usage
A NatsServer class can also be used to start a server.
import { NatsServer } from 'nats-nest'
const server = new NatsServer()
// The options are optional
await server.start({
host: '127.0.0.1',
port: 4222,
name: 'NATS_Server',
jetstream: true,
})
// Stopping the server
await server.stop()Configuration Options
Server config options can also be set when starting the server.
| Field | Type | Flag(s) | Environment Variable | Default | Help |
|---|---|---|---|---|---|
Host | string | -h, --host | NATS_NEST_HOST | 0.0.0.0 | Host on which the NATS server will listen |
Port | int | -p, --port | NATS_NEST_PORT | 4222 | Port on which the NATS server will listen |
HTTPPort | int | -m, --http-port | NATS_NEST_HTTP_PORT | HTTP port for monitoring dashboard (exclusive of --https-port) | |
HTTPSPort | int | --https-port | NATS_NEST_HTTPS_PORT | HTTPS port for monitoring dashboard (exclusive of --httpx-port) | |
Name | string | -n, --name | NATS_NEST_NAME | Server name | |
PidFile | string | -P, --pid | NATS_NEST_PID | File to write the server's PID | |
Config | string | -c, --config | NATS_NEST_CONFIG | Path to configuration file | |
LogFile | string | -l, --log | File to redirect log output | ||
NoLog | bool | --no-log | NATS_NEST_NO_LOG | Disable logging | |
Debug | bool | -D, --debug | NATS_NEST_DEBUG | Enable debug mode | |
Syslog | bool | -s, --syslog | Log to syslog or windows event log | ||
Jetstream | bool | --jetstream | Enable JetStream functionality | ||
StoreDir | string | --store_dir | Set the storage directory |
Examples:
Setting a name and enabling Jetsream
npx nats-nest --name "MyNatsServer" --jetstreamSetting the port and host
npx nats-nest --port 4222 --host 127.0.0.1