capacitor-websockets 🔌
Simple WebSockets client and server for the Capacitor framework. It's only a really basic implementation with some caveats.
If you find any bugs or have improvements create an issue or pull request.
Install
npm install capacitor-websockets
npx cap sync
API
startServer(...)
startServer ( options ?: StartOptions | undefined ) = > Promise < { port : number ; } >
Returns: Promise<{ port: number; }>
startClient(...)
startClient ( options ?: ClientOptions | undefined ) = > Promise < { url : string ; } >
Returns: Promise<{ url: string; }>
stop()
sendMessage(...)
sendMessage ( options ?: MessageData | undefined ) = > Promise < void >
addListener('onOpen', ...)
addListener ( eventName : 'onOpen' , listenerFunc : ( connection : SocketData ) = > void ) => Promise < PluginListenerHandle > & PluginListenerHandle
Param
Type
eventName
'onOpen'
listenerFunc
(connection: SocketData ) => void
Returns: Promise<PluginListenerHandle > & PluginListenerHandle
addListener('onClose', ...)
addListener ( eventName : 'onClose' , listenerFunc : ( data : CloseData ) = > void ) => Promise < PluginListenerHandle > & PluginListenerHandle
Param
Type
eventName
'onClose'
listenerFunc
(data: CloseData ) => void
Returns: Promise<PluginListenerHandle > & PluginListenerHandle
addListener('onMessage', ...)
addListener ( eventName : 'onMessage' , listenerFunc : ( data : MessageData ) = > void ) => Promise < PluginListenerHandle > & PluginListenerHandle
Param
Type
eventName
'onMessage'
listenerFunc
(data: MessageData ) => void
Returns: Promise<PluginListenerHandle > & PluginListenerHandle
addListener('onError', ...)
addListener ( eventName : 'onError' , listenerFunc : ( data : CloseData ) = > void ) => Promise < PluginListenerHandle > & PluginListenerHandle
Param
Type
eventName
'onError'
listenerFunc
(data: CloseData ) => void
Returns: Promise<PluginListenerHandle > & PluginListenerHandle
Interfaces
StartOptions
ClientOptions
MessageData
SocketData
Prop
Type
ip
string
host
number
PluginListenerHandle
Prop
Type
remove
() => Promise<void>
CloseData