A websocket transport for the Kalm framework.

• Detects native Websocket APIs, or fallbacks to ws
• Supports secure connections

Installing

npm install @kalm/ws

Options

{
    /** The certificate file content for a secure socket connection, both this and `key` must be set */
    cert?: string
    /** The key file content for a secure socket connection, both this and `cert` must be set */
    key?: string
    /** Indicates wether a server or client should use wss:// protocol. Will throw an error if set without cert or key on the server */
    secure?: boolean
    /** The maximum idle time for the connection before it hangs up (default: 30000) */
    socketTimeout: number
}

For more info, refer to the Kalm Homepage

Contribute

If you think of something that you want, open an issue or file a pull request, we'll be more than happy to take a look!

License

Apache 2.0 (c) 2025 Frederic Charette