{"id":21531929,"url":"https://github.com/matrixai/js-ws","last_synced_at":"2025-08-02T16:03:49.882Z","repository":{"id":188857491,"uuid":"662083538","full_name":"MatrixAI/js-ws","owner":"MatrixAI","description":"Websocket Transport Library for TypeScript/JavaScript Applications","archived":false,"fork":false,"pushed_at":"2025-05-13T04:16:28.000Z","size":1408,"stargazers_count":2,"open_issues_count":7,"forks_count":0,"subscribers_count":5,"default_branch":"staging","last_synced_at":"2025-05-13T04:30:02.987Z","etag":null,"topics":["websocket-client","websocket-server","websocket-stream","websockets"],"latest_commit_sha":null,"homepage":"https://matrixai.github.io/js-ws/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MatrixAI.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-07-04T10:14:08.000Z","updated_at":"2025-03-28T00:31:03.000Z","dependencies_parsed_at":"2025-05-13T04:26:44.369Z","dependency_job_id":"b290db18-7087-466e-88a8-3028854c8f7f","html_url":"https://github.com/MatrixAI/js-ws","commit_stats":null,"previous_names":["matrixai/js-ws"],"tags_count":24,"template":false,"template_full_name":null,"purl":"pkg:github/MatrixAI/js-ws","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MatrixAI%2Fjs-ws","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MatrixAI%2Fjs-ws/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MatrixAI%2Fjs-ws/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MatrixAI%2Fjs-ws/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MatrixAI","download_url":"https://codeload.github.com/MatrixAI/js-ws/tar.gz/refs/heads/staging","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MatrixAI%2Fjs-ws/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268415800,"owners_count":24246809,"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-08-02T02:00:12.353Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","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":["websocket-client","websocket-server","websocket-stream","websockets"],"created_at":"2024-11-24T02:18:13.006Z","updated_at":"2025-08-02T16:03:49.870Z","avatar_url":"https://github.com/MatrixAI.png","language":"TypeScript","readme":"# js-ws\n\nWebSocket library for TypeScript/JavaScript applications.\n\nThis is built on top of the [ws](https://github.com/websockets/ws) library,\nproviding a multiplexed WebStreams API on top of WebSocket.\n\n## Installation\n\n```sh\nnpm install --save @matrixai/ws\n```\n\n### Browser Usage\n\nTo use `WebSocketClient` in a browser environment, you will need to polyfill:\n\n- [`buffer`](https://nodejs.org/api/buffer.html)\n- [`perf_hooks`](https://nodejs.org/api/perf_hooks.html)\n\nA good choice for a `buffer` polyfill is\n[`feross/buffer`](https://github.com/feross/buffer)\n\nTo polyfill `perf_hooks`, you can alias the `perf_hooks` using your bundler of\nchoice with a file containing the following code:\n\n```ts\nconst { performance } = globalThis;\nexport { performance };\n```\n\n## Development\n\nRun `nix develop`, and once you're inside, you can use:\n\n```sh\n# install (or reinstall packages from package.json)\nnpm install\n# build the dist\nnpm run build\n# run the repl (this allows you to import from ./src)\nnpm run tsx\n# run the tests\nnpm run test\n# lint the source code\nnpm run lint\n# automatically fix the source\nnpm run lintfix\n```\n\n### Docs Generation\n\n```sh\nnpm run docs\n```\n\nSee the docs at: https://matrixai.github.io/js-ws/\n\n### Publishing\n\n```sh\n# npm login\nnpm version patch # major/minor/patch\nnpm run build\nnpm publish --access public\ngit push\ngit push --tags\n```\n\n## License\n\njs-ws is licensed under Apache-2.0, you may read the terms of the license\n[here](LICENSE).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatrixai%2Fjs-ws","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatrixai%2Fjs-ws","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatrixai%2Fjs-ws/lists"}