Polyweave

Repositories

1

Projects Packages

@polyweave/push-websocket (1.0.0)

Published 2026-07-10 15:59:24 +00:00 by Dvorak

Installation

Set up this registry in your project .npmrc file:

@polyweave:registry=https://hub.kl1.tenere.ai/api/packages/Polyweave/npm/

To install the package using npm, run the following command:

npm install @polyweave/push-websocket@1.0.0

or add it to the package.json file:

"@polyweave/push-websocket": "1.0.0"

For more information on the npm registry, see the documentation.

About this package

push-websocket

Minimal push-stream WebSocket shim wrapping the ws library.

Synopsis

import { createWebSocket, STATE } from '@polyweave/push-websocket';

const ws = createWebSocket('wss://example.com/socket', {
  headers: { 'Authorization': 'Bearer token' },
  onOpen: () => console.log('connected'),
  onError: (err) => console.error(err),
  onClose: (code, reason) => console.log('closed', code, reason)
});

// ws is a standard WebSocket instance with .send(), .close(), etc.
if (ws.readyState === STATE.OPEN) {
  ws.send(JSON.stringify({ type: 'hello' }));
}

Install

npm install @polyweave/push-websocket

API

createWebSocket(url, options)

Create a WebSocket connection using the ws library.

Parameters:

• url: WebSocket URL string
• options.headers: optional HTTP headers
• options.onOpen(): callback for connection open
• options.onError(err): callback for errors
• options.onClose(code, reason): callback for connection close

Returns a standard WebSocket instance.

STATE

Ready state constants: CONNECTING (0), OPEN (1), CLOSING (2), CLOSED (3).

Requirements

Node.js 18 or later. ESM only.

License

MIT

Dependencies

Dependencies

ID	Version
ws	^8.19.0

Keywords

websocket push-stream ws

Details

npm

2026-07-10 15:59:24 +00:00

46

John Dvorak

SEE LICENSE IN LICENSE

1.7 KiB

Assets (1)

push-websocket-1.0.0.tgz 1.7 KiB

Versions (2) View all

1.0.1 2026-07-10

1.0.0 2026-07-10