Skip to content

Commit c11e552

Browse files
committed
1 parent ba15d58 commit c11e552

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

docs/ROPE-client/API.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
* [.module.exports](#RopeClient.module.exports)
1111
* [new module.exports(url, options)](#new_RopeClient.module.exports_new)
1212
* [.Connection](#RopeClient.Connection)
13-
* [.open(url)](#RopeClient.open) ⇒ <code>\*</code>
13+
* [.open(url)](#RopeClient.open)[<code>RopeClient</code>](#RopeClient)
1414

1515
<a name="RopeClient.module.exports"></a>
1616

@@ -37,12 +37,13 @@ Creates an instance of RopeClient.
3737
**Author**: Jesús Leganés-Combarro 'piranna' <[email protected]>
3838
<a name="RopeClient.open"></a>
3939

40-
### RopeClient.open(url) ⇒ <code>\*</code>
40+
### RopeClient.open(url) ⇒ [<code>RopeClient</code>](#RopeClient)
4141
**Kind**: static method of [<code>RopeClient</code>](#RopeClient)
42+
**Returns**: [<code>RopeClient</code>](#RopeClient) - this
4243
**Date**: 20/12/2022
4344
**Author**: Jesús Leganés-Combarro 'piranna' <[email protected]>
4445

45-
| Param | Type |
46-
| --- | --- |
47-
| url | <code>\*</code> |
46+
| Param | Type | Description |
47+
| --- | --- | --- |
48+
| url | <code>string</code> | The URL to connect to the server endpoint (WebSocket) |
4849

docs/ROPE-client/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Constructor of the client.
2929
### readyState
3030

3131
Property showing the actual state of the connection, possible values are
32-
`CONNECTING`, `OPEN`, `CLOSSING`, `CLOSED` and `CONNECTED`. `CONNECTED` state is
32+
`CONNECTING`, `OPEN`, `CLOSING`, `CLOSED` and `CONNECTED`. `CONNECTED` state is
3333
reached after receiving initial payload from server with its current state.
3434

3535
### close()

0 commit comments

Comments
 (0)