capacitor-tcp-socket

A TCP Socket Plugin for capacitor

Install

``bash
npm install capacitor-tcp-socket
npx cap sync
`

API

* connect(...)
* send(...)
* read(...)
* disconnect(...)
* Interfaces

$3

`typescript
connect(options: ConnectOptions) => Promise
`

| Param | Type |
| ------------- | --------------------------------------------------------- |
| options | ConnectOptions |

Returns: Promise<ConnectResult>

--------------------

$3

`typescript
send(options: SendOptions) => Promise
`

| Param | Type |
| ------------- | --------------------------------------------------- |
| options | SendOptions |

--------------------

$3

`typescript
read(options: ReadOptions) => Promise
`

| Param | Type |
| ------------- | --------------------------------------------------- |
| options | ReadOptions |

Returns: Promise<ReadResult>

--------------------

$3

`typescript
disconnect(options: DisconnectOptions) => Promise
`

| Param | Type |
| ------------- | --------------------------------------------------------------- |
| options | DisconnectOptions |

Returns: Promise<DisconnectResult>

--------------------

$3


#### ConnectResult

| Prop | Type |
| ------------ | ------------------- |
| client | number |


#### ConnectOptions

| Prop | Type |
| --------------- | ------------------- |
| ipAddress | string |
| port | number |


#### SendOptions

| Prop | Type |
| -------------- | ------------------- |
| client | number |
| data | string |
| encoding | 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 |