Skip to content

Yurba.js / @yurbajs/ws


yurba.js logo


npm versionnpm downloadsLast commitnpm last update

About

WebSocket client for yurba.one with real-time messaging support.

WARNING: it's alpha version

Install

Node.js 20 or newer is required.

sh
npm install @yurbajs/ws
yarn add @yurbajs/ws
pnpm add @yurbajs/ws
bun add @yurbajs/ws

Example usage

js
import { ReconnectingWebSocket } from '@yurbajs/ws';

const ws = new ReconnectingWebSocket(`wss://api.yurba.one/ws?token=${TOKEN}`);

ws.on('message', (message) => {
  console.log('Received message:', message);
});

ws.on('open', () => {
  console.log('WebSocket connected!');
});

ws.on('error', (error) => {
  console.error('WebSocket error:', error);
});

Contributing

Want to help make yurba.js better?

Please make sure to follow our coding style and test your changes before submitting.

Getting Help

Need assistance?

Classes

References

default

Renames and re-exports ReconnectingWebSocket