Class NatsDriver

NATS-based signaling driver for inter-process communication.

This driver uses NATS as the underlying messaging system, allowing for distributed signaling across multiple browsers and devices.

This driver requires the nats.ws library for WebSocket-based NATS connections directly in the browser.

Example

import { connect } from 'https://esm.sh/nats.ws';

// connect to a NATS server (e.g. the public demo server) 
const nc = await connect({ servers: ['wss://demo.nats.io:8443'] });

// create a new driver instance and start it
const driver = new NatsDriver({ nc, prefix: 'peerix' });
driver.start();

Hierarchy (View Summary)

Driver
- NatsDriver

Index

Constructors

constructor

new NatsDriver(options: { nc: any; prefix?: string }): NatsDriver
Creates a new instance of the driver.
Parameters
- options: { nc: any; prefix?: string }
  Configuration options for the driver.
  - nc: any
    A NATS connection instance.
  - Optionalprefix?: string
    An optional prefix for NATS subjects.
Returns NatsDriver
Overrides Driver.constructor
- Defined in src/drivers/nats.ts:38

Accessors

active

get active(): boolean
Indicates whether the driver is currently active.

Returns boolean
Inherited from Driver.active
- Defined in src/drivers/driver.ts:33
set active(value: boolean): void
Sets the active state of the driver and emits corresponding events.
Parameters
- value: boolean
Returns void
Inherited from Driver.active
- Defined in src/drivers/driver.ts:38

Methods

dispatch

dispatch(namespace: string[], message: Uint8Array): Promise<void>
Dispatches a signaling message to the specified namespace.
Parameters
- namespace: string[]
  The namespace to dispatch the message to.
- message: Uint8Array
  The message to dispatch.
Returns Promise<void>
Overrides Driver.dispatch
- Defined in src/drivers/nats.ts:98

emit

emit<K extends keyof DriverEvents>(event: K, ...args: DriverEvents[K]): void
Emits an internal event with optional data.
Type Parameters
- K extends keyof DriverEvents
Parameters
- event: K
  The event name.
- ...args: DriverEvents[K]
  The data to pass to event handlers.
Returns void
Inherited from Driver.emit
- Defined in src/drivers/driver.ts:78

off

off<K extends keyof DriverEvents>(
event: K,
handler: (...args: DriverEvents[K]) => void,
): void
Unregisters an event handler for the specified internal event.
Type Parameters
- K extends keyof DriverEvents
Parameters
- event: K
  The event name.
- handler: (...args: DriverEvents[K]) => void
  The event handler function to remove.
Returns void
Inherited from Driver.off
- Defined in src/drivers/driver.ts:68

on

on<K extends keyof DriverEvents>(
event: K,
handler: (...args: DriverEvents[K]) => void,
): void
Registers an event handler for the specified internal event.
Type Parameters
- K extends keyof DriverEvents
Parameters
- event: K
  The event name.
- handler: (...args: DriverEvents[K]) => void
  The event handler function.
Returns void
Inherited from Driver.on
- Defined in src/drivers/driver.ts:58

start

start(): Promise<void>
Starts the driver and begins tracking NATS connection status.

Returns Promise<void>
- Defined in src/drivers/nats.ts:50

stop

stop(): Promise<void>
Stops the driver.

Returns Promise<void>
- Defined in src/drivers/nats.ts:60

subscribe(
namespace: string[],
handler: (message: Uint8Array) => void,
): Promise<void>
Subscribes to signaling messages for the specified namespace.
Parameters
- namespace: string[]
  The namespace to subscribe to.
- handler: (message: Uint8Array) => void
  The handler function to call when a message is received.
Returns Promise<void>
Overrides Driver.subscribe
- Defined in src/drivers/nats.ts:66

unsubscribe

unsubscribe(
namespace: string[],
handler: (message: Uint8Array) => void,
): Promise<void>
Unsubscribes from signaling messages for the specified namespace.
Parameters
- namespace: string[]
  The namespace to unsubscribe from.
- handler: (message: Uint8Array) => void
  The handler function to remove.
Returns Promise<void>
Overrides Driver.unsubscribe
- Defined in src/drivers/nats.ts:83

Class NatsDriver

Example

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

nc: any

Optionalprefix?: string

Returns NatsDriver

Accessors

active

Returns boolean

Parameters

Returns void

Methods

dispatch

Parameters

Returns Promise<void>

emit

Type Parameters

Parameters

Returns void

off

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

Returns void

start

Returns Promise<void>

stop

Returns Promise<void>

subscribe

Parameters

Returns Promise<void>

unsubscribe

Parameters

Returns Promise<void>

Settings

On This Page

`Optional`prefix?: string