Skip to content

gee1k/capacitor-tcp-socket

Repository files navigation

capacitor-tcp-socket

A TCP Socket Plugin for capacitor

Thanks @ottimis

Install

npm install capacitor-tcp-socket
npx cap sync

API

connect(...)

connect(options: ConnectOptions) => Promise<ConnectResult>
Param Type
options ConnectOptions

Returns: Promise<ConnectResult>


send(...)

send(options: SendOptions) => Promise<void>
Param Type
options SendOptions

read(...)

read(options: ReadOptions) => Promise<ReadResult>
Param Type
options ReadOptions

Returns: Promise<ReadResult>


disconnect(...)

disconnect(options: DisconnectOptions) => Promise<DisconnectResult>
Param Type
options DisconnectOptions

Returns: Promise<DisconnectResult>


Interfaces

ConnectResult

Prop Type
client number

ConnectOptions

Prop Type
ipAddress string
port number

SendOptions

Prop Type
client number
data string

ReadResult

Prop Type
result string

ReadOptions

Prop Type Description
client number
expectLen number
timeout number timeout in seconds. default: 10 only ios supports timeout.

DisconnectResult

Prop Type
client number

DisconnectOptions

Prop Type
client number