cordova/sockets-for-cordova
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Martin Obrátil 2014-11-10 10:58:53 +01:00
parent c99ea1cf48
commit e79219cd87
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -5,8 +5,8 @@ Cordova plugin for socket network communication
## API
### Event handlers
#### `onData: (data: Int8Array) => void`
Called when new batch of data was send from server to client. Data are represented as typed array of bytes (`Int8Array`).
#### `onData: (data: Uint8Array) => void`
Called when new batch of data was send from server to client. Data are represented as typed array of bytes (`Uint8Array`).
#### `onClose: (hasError: boolean) => void`
Called after connection was successfully closed. Parameter `hasError` indicates whether connection was closed as a result of some error.
@ -30,7 +30,7 @@ Sends data to the remote host.
| parameter | type | description |
| ----------- |-----------------------------|--------------|
| `data` | `Int8Array` | Typed array of bytes to be written to the output stream |
| `data` | `Uint8Array` | Typed array of bytes to be written to the output stream |
| `onSuccess` | `() => void` | Success callback, called after data are successfully written to the output stream. (optional)|
| `onError` | `(message: string) => void` | Error callback, called when some error occurs during writing of data to the output stream. (optional)|