{"id":15592107,"url":"https://github.com/derhuerst/websocket-pool","last_synced_at":"2025-07-23T10:05:03.664Z","repository":{"id":32726394,"uuid":"140964544","full_name":"derhuerst/websocket-pool","owner":"derhuerst","description":"A pool of WebSocket connections. Supports reconnecting.","archived":false,"fork":false,"pushed_at":"2022-07-22T13:51:54.000Z","size":19,"stargazers_count":22,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-07-23T10:03:12.739Z","etag":null,"topics":["load-balancer","pool","reconnect","websocket"],"latest_commit_sha":null,"homepage":"https://github.com/derhuerst/websocket-pool#websocket-pool","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/derhuerst.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-14T17:19:55.000Z","updated_at":"2025-02-22T23:53:06.000Z","dependencies_parsed_at":"2022-07-16T04:46:14.626Z","dependency_job_id":null,"html_url":"https://github.com/derhuerst/websocket-pool","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/derhuerst/websocket-pool","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derhuerst%2Fwebsocket-pool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derhuerst%2Fwebsocket-pool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derhuerst%2Fwebsocket-pool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derhuerst%2Fwebsocket-pool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/derhuerst","download_url":"https://codeload.github.com/derhuerst/websocket-pool/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derhuerst%2Fwebsocket-pool/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266657954,"owners_count":23963602,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-23T02:00:09.312Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["load-balancer","pool","reconnect","websocket"],"created_at":"2024-10-02T23:54:50.891Z","updated_at":"2025-07-23T10:05:03.634Z","avatar_url":"https://github.com/derhuerst.png","language":"JavaScript","readme":"# websocket-pool\n\n**A pool of [WebSocket](https://en.wikipedia.org/wiki/WebSocket) connections. Supports reconnecting.** Allows load-balancing messages over multiple WebSocket servers, using any [scheduling scheme](https://en.wikipedia.org/wiki/Scheduling_(computing)#Scheduling_disciplines) (e.g. [round robin](https://en.wikipedia.org/wiki/Round-robin_scheduling)).\n\n[![npm version](https://img.shields.io/npm/v/websocket-pool.svg)](https://www.npmjs.com/package/websocket-pool)\n[![build status](https://api.travis-ci.org/derhuerst/websocket-pool.svg?branch=master)](https://travis-ci.org/derhuerst/websocket-pool)\n![ISC-licensed](https://img.shields.io/github/license/derhuerst/websocket-pool.svg)\n[![support me via GitHub Sponsors](https://img.shields.io/badge/support%20me-donate-fa7664.svg)](https://github.com/sponsors/derhuerst)\n[![chat with me on Twitter](https://img.shields.io/badge/chat%20with%20me-on%20Twitter-1da1f2.svg)](https://twitter.com/derhuerst)\n\n\n## Installation\n\n```shell\nnpm install websocket-pool\n```\n\n\n## Usage\n\n```js\nconst createPool = require('websocket-pool')\nconst WebSocket = require('ws')\nconst createRoundRobin = require('@derhuerst/round-robin-scheduler')\n\nconst pool = createPool(WebSocket, createRoundRobin)\n\n// incoming message, just like websocket.on('message')\npool.on('message', (msg) =\u003e {\n\tconsole.log('\u003c-', msg.data)\n\tpool.close()\n})\n\n// \u003e= 1 connection in the pool is open\npool.once('open', () =\u003e {\n\tpool.send('hello there')\n})\n\n// the pool failed to reconnect after retrying\npool.on('error', (err) =\u003e {\n\tconsole.error(err)\n})\n\nconst urls = [\n\t'ws://echo.websocket.org/#1',\n\t'ws://echo.websocket.org/#2',\n\t'ws://echo.websocket.org/#3'\n]\nfor (let url of urls) pool.add(url)\n```\n\n`websocket-pool` accepts any [`WebSocket`](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket) implementation. For example, you can use the native implementation in browsers or [`ws`](https://npmjs.com/package/ws) in Node.\n\nThe `createScheduler` function must implement the [`abstract-scheduler` interface](https://github.com/derhuerst/abstract-scheduler).\n\n\n## Related\n\n- [`reconnecting-websocket`](https://www.npmjs.com/package/reconnecting-websocket) – If want to connect to only one server.\n- [`node-pool`](https://github.com/coopernurse/node-pool) – Generic pool. You have to write the adapter to the resource.\n\n\n## Contributing\n\nIf you have a question or need support using `websocket-pool`, please double-check your code and setup first. If you think you have found a bug or want to propose a feature, refer to [the issues page](https://github.com/derhuerst/websocket-pool/issues).\n","funding_links":["https://github.com/sponsors/derhuerst"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fderhuerst%2Fwebsocket-pool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fderhuerst%2Fwebsocket-pool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fderhuerst%2Fwebsocket-pool/lists"}