https://github.com/matrixai/js-ws
Websocket Transport Library for TypeScript/JavaScript Applications
https://github.com/matrixai/js-ws
websocket-client websocket-server websocket-stream websockets
Last synced: 7 months ago
JSON representation
Websocket Transport Library for TypeScript/JavaScript Applications
- Host: GitHub
- URL: https://github.com/matrixai/js-ws
- Owner: MatrixAI
- License: apache-2.0
- Created: 2023-07-04T10:14:08.000Z (over 2 years ago)
- Default Branch: staging
- Last Pushed: 2025-05-13T04:16:28.000Z (10 months ago)
- Last Synced: 2025-05-13T04:30:02.987Z (10 months ago)
- Topics: websocket-client, websocket-server, websocket-stream, websockets
- Language: TypeScript
- Homepage: https://matrixai.github.io/js-ws/
- Size: 1.34 MB
- Stars: 2
- Watchers: 5
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# js-ws
WebSocket library for TypeScript/JavaScript applications.
This is built on top of the [ws](https://github.com/websockets/ws) library,
providing a multiplexed WebStreams API on top of WebSocket.
## Installation
```sh
npm install --save @matrixai/ws
```
### Browser Usage
To use `WebSocketClient` in a browser environment, you will need to polyfill:
- [`buffer`](https://nodejs.org/api/buffer.html)
- [`perf_hooks`](https://nodejs.org/api/perf_hooks.html)
A good choice for a `buffer` polyfill is
[`feross/buffer`](https://github.com/feross/buffer)
To polyfill `perf_hooks`, you can alias the `perf_hooks` using your bundler of
choice with a file containing the following code:
```ts
const { performance } = globalThis;
export { performance };
```
## Development
Run `nix develop`, and once you're inside, you can use:
```sh
# install (or reinstall packages from package.json)
npm install
# build the dist
npm run build
# run the repl (this allows you to import from ./src)
npm run tsx
# run the tests
npm run test
# lint the source code
npm run lint
# automatically fix the source
npm run lintfix
```
### Docs Generation
```sh
npm run docs
```
See the docs at: https://matrixai.github.io/js-ws/
### Publishing
```sh
# npm login
npm version patch # major/minor/patch
npm run build
npm publish --access public
git push
git push --tags
```
## License
js-ws is licensed under Apache-2.0, you may read the terms of the license
[here](LICENSE).