Awesome

@wahr/capacitor-websocket-client

Capacitor WebSocket Client Plugin.

Install

npm install @wahr/capacitor-websocket-client
npx cap sync

Platform support

• Web
• Android

Unfortunately, we do not have a macOS device, but we are working hard.

Example

Single connect

await WebSocket.onOpen({}, (message, err) => {
    //do something...
    console.log("onOpen event have a bug: ", err?.toString())
})

await WebSocket.onMessage({}, (message, err) => {
    //do something...
    console.log(`received message content: ${message?.data}`)
})

await WebSocket.connect({url: "ws://example.com"})

setTimeout(async () => {
    await WebSocket.send({data: "hello world!"})
}, 2000);

Multiple connect

await WebSocket.onOpen({id: "chat-websocket"}, (message, err) => {
    //do something...
    console.log("onOpen event have a bug: ", err?.toString())
})

await WebSocket.connect({url: "ws://example.com/chat", id: "chat-websocket"})

await WebSocket.onMessage({id: "notify-websocket"}, (message, err) => {
    //do something...
    console.log(`received notify content: ${message?.data}`)
})

await WebSocket.connect({url: "ws://example.com/notify", id: "notify-websocket"})

setTimeout(async () => {
    await WebSocket.send({data: "hello world!", id: "chat-websocket"})
    await WebSocket.send({data: "connect notify.", id: "notify-websocket"})
}, 2000)

API

• connect(...)
• close(...)
• send(...)
• onOpen(...)
• onMessage(...)
• onClose(...)
• onError(...)
• Interfaces
• Type Aliases

connect(...)

connect(options
:
ConnectionOptions
) =>
Promise<void>

Initiate a WebSocket connection.

Since: 0.0.1

close(...)

close(options ? : CloseOptions | undefined)
=>
Promise<void>

Close the connection.

send(...)

send(options
:
SendMessageOptions
) =>
Promise<void>

Send a message.

Since: 0.0.1

onOpen(...)

onOpen(options
:
OnOpenOptions, callback
:
OnOpenCallback
) =>
Promise<void>

Register a callback to be invoked when the connection is opened.

Since: 0.0.3

onMessage(...)

onMessage(options
:
OnMessageOptions, callback
:
OnMessageCallback
) =>
Promise<void>

Register a callback to be invoked when a message is received.

Since: 0.0.3

onClose(...)

onClose(options
:
OnCloseOptions, callback
:
OnCloseCallback
) =>
Promise<void>

Register a callback to be invoked when the connection is closed.

Since: 0.0.3

onError(...)

onError(options
:
OnErrorOptions, callback
:
OnErrorCallback
) =>
Promise<void>

Register a callback to be invoked when an error occurs.

Since: 0.0.3

Interfaces

ConnectionOptions

CloseOptions

SendMessageOptions

OnOpenOptions

OnOpenData

OnMessageOptions

OnMessageData

OnCloseOptions

OnCloseData

OnErrorOptions

OnErrorData

Type Aliases

OnOpenCallback

<code>(message: <a href="#onopendata">OnOpenData</a> | null, err?: any): void</code>

OnMessageCallback

<code>(message: <a href="#onmessagedata">OnMessageData</a> | null, err?: any): void</code>

OnCloseCallback

<code>(message: <a href="#onclosedata">OnCloseData</a> | null, err?: any): void</code>

OnErrorCallback

<code>(message: <a href="#onerrordata">OnErrorData</a> | null, err?: any): void</code>