Skip to content

Commit ae0f2d5

Browse files
committed
Add deno instructions
1 parent 31317f9 commit ae0f2d5

2 files changed

Lines changed: 31 additions & 1 deletion

File tree

js/network/socketiyo-client/examples/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
"type": "module",
55
"scripts": {
66
"serve": "serve ../.",
7-
"node-client": "node exampleNodeClient.js"
7+
"node": "node exampleNodeClient.js",
8+
"deno": "deno run --allow-net exampleClient.js"
89
},
910
"devDependencies": {
1011
"serve": "^11.3.2"

js/network/socketiyo/readme.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ WebSocket-based, bi-directional events in between client and server.
88
* Light-weight
99
* Modern
1010

11+
## Platforms
12+
13+
- socketiyo (server): NodeJs
14+
- socketiyo-client: NodeJs, Web, Deno
15+
1116
## Usage
1217

1318
### Install
@@ -118,6 +123,10 @@ socketiYoServer.close()
118123

119124
### Client
120125

126+
#### Import
127+
128+
##### Node
129+
121130
```js
122131
import {
123132
createConnection,
@@ -128,7 +137,27 @@ import {
128137
} from "socketiyo-client/source/socketiyo-client.js";
129138
import { reconnectDelay, randomReconnectDelay, autoReconnect } from "socketiyo-client/source/defaultOptions.js";
130139
import { useDefaultLogging } from "socketiyo-client/source/defaultLogging.js";
140+
```
131141

142+
##### Deno and Web
143+
144+
145+
```js
146+
import {
147+
createConnection,
148+
CONNECT,
149+
DISCONNECT,
150+
ERROR,
151+
DEFAULT_CHANNEL
152+
} from "https://unpkg.com/socketiyo-client/source/socketiyo-client.js";
153+
import { reconnectDelay, randomReconnectDelay, autoReconnect } from "https://unpkg.com/socketiyo-client/source/defaultOptions.js";
154+
import { useDefaultLogging } from "https://unpkg.com/socketiyo-client/source/defaultLogging.js";
155+
```
156+
157+
158+
#### usage
159+
160+
```js
132161

133162
const socketiyoConnection = createConnection({
134163
url: `ws://localhost:8080/socketiyo`,

0 commit comments

Comments
 (0)