js-ws

WebSocket library for TypeScript/JavaScript applications.

This is built on top of the ws library, providing a multiplexed WebStreams API on top of WebSocket.

Installation

``sh
npm install --save @matrixai/ws
`

$3

To use WebSocketClient in a browser environment, you will need to polyfill:

* buffer
* perf_hooks

A good choice for a buffer polyfill is 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
`

$3

`sh
npm run docs
`

See the docs at: https://matrixai.github.io/js-ws/

$3

`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.