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: about 2 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 1 year ago)
• Default Branch: staging
• Last Pushed: 2024-06-28T07:13:35.000Z (7 months ago)
• Last Synced: 2024-06-29T09:27:40.744Z (7 months ago)
• Topics: websocket-client, websocket-server, websocket-stream, websockets
• Language: TypeScript
• Homepage: https://polykey.com
• Size: 961 KB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 3
• 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).