File tree Expand file tree Collapse file tree 2 files changed +7
-6
lines changed
Expand file tree Collapse file tree 2 files changed +7
-6
lines changed Original file line number Diff line number Diff line change 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' < piranna@gmail.com >
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' < piranna@gmail.com >
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
Original file line number Diff line number Diff line change @@ -29,7 +29,7 @@ Constructor of the client.
2929### readyState
3030
3131Property 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
3333reached after receiving initial payload from server with its current state.
3434
3535### close()
You can’t perform that action at this time.
0 commit comments