melishev/wsgo

WebSocket client for the browser. Simplifying development and debugging

WSGO

WebSocket client for the browser. Simplifying development and debugging

Note

Please lock the version of the package. This library is not stable yet and may have some behavioral differences depending on the version.

What is WSGO?

The WSGO library acts as an abstraction on top of a pure WebSocket connection. Think of it as:

• Socket.io, only without being tied to your server implementation
• Axios, just for WebSocket communication

WSGO is designed to standardize communication between client and server through an explicit and common communication format

Getting Started

To install the library in your project:

npm i wsgo

Then import WSGO into your code to create a connection to the server with the default settings:

import WSGO from 'wsgo'

const wsgo = WSGO('wss://echo.websocket.org')

Options

debugging

Allows you to enable debugging mode when working with events. Logs outgoing and incoming events more informative than default browser developer tools

• type: boolean
• default: false

immediate

Whether to connect to the server automatically when WSGO is initialized. If set to false, call the open method yourself when you are ready

• type: boolean
• default: true

heartbeat

Implements the basic ping-pong mechanism. If there is no response from the server, closes the connection

• type: boolean
• default: true

Examples

Create a WebSocket connection:

import WSGO from 'wsgo'

const wsgo = WSGO('wss://echo.websocket.org')

Open the connection manually:

import WSGO from 'wsgo'

const wsgo = WSGO('wss://echo.websocket.org', {
  immediate: false,
})

wsgo.open()

Register an event listener:

import WSGO from 'wsgo'

const wsgo = WSGO('wss://echo.websocket.org')

wsgo.subscribe('my-event', (e) => {
  console.log(e)
})

Send the event to the server:

import WSGO from 'wsgo'

const wsgo = WSGO('wss://echo.websocket.org')

wsgo.send('my-event', { text: 'Hello world!' })

Get the original and unmodified Websocket instance:

import WSGO from 'wsgo'

const wsgo = WSGO('wss://echo.websocket.org')

const status = wsgo.ws.readyState

Close the connection:

import WSGO from 'wsgo'

const wsgo = WSGO('wss://echo.websocket.org')

wsgo.close()

Feedback

WSGO is designed to create a convenient and easy way to interact with WebSocket. We would love to get your ideas on how to make it even better.

wsgo's Issues

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

No npm token specified.

An npm token must be created and set in the NPM_TOKEN environment variable on your CI environment.

Please make sure to create an npm token and to set it in the NPM_TOKEN environment variable on your CI environment. The token must allow to publish to the registry https://registry.npmjs.org/.

---

Good luck with your project ✨

Your semantic-release bot 📦🚀

Logo

Generating provenance statements // npm

https://docs.npmjs.com/generating-provenance-statements

Create sandbox

I think we need to create a sandbox, with the ability to connect to locally running servers. This will allow developers to test connecting to a server using the library before implementing it in an existing project. It would also be nice if developers could create problem situations inside the sandbox, where they could understand what the problem is when using the library.