itty-sockets 0.9.0 → 0.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -22,7 +22,17 @@
|
|
|
22
22
|
|
|
23
23
|
No accounts, no API keys, nothing to deploy. Just connect and start sending.
|
|
24
24
|
|
|
25
|
-
**~466 bytes**
|
|
25
|
+
### **~466 bytes** • **free forever**
|
|
26
|
+
|
|
27
|
+
<br />
|
|
28
|
+
|
|
29
|
+
> After working in realtime for quite a few years, I wanted something absolutely frictionless for prototyping. Spinning up socket servers or authenticating to services like Pusher/Ably involves overhead every time... so I built a service for myself (and everyone else). Then I designed this super-tiny WebSocket client that made even *that* side really easy to work with.
|
|
30
|
+
>
|
|
31
|
+
> Welcome to `itty-sockets`!
|
|
32
|
+
>
|
|
33
|
+
> ~ Kevin W
|
|
34
|
+
|
|
35
|
+
<br />
|
|
26
36
|
|
|
27
37
|
## Features
|
|
28
38
|
- **Zero Configuration** - No accounts, no API keys, no server. Pick a channel name and you're live.
|
|
@@ -33,6 +43,8 @@ No accounts, no API keys, nothing to deploy. Just connect and start sending.
|
|
|
33
43
|
- **Use Anywhere** - No vendor lock. This client works with *any* WebSocket server. Want to host your own? No problem.
|
|
34
44
|
- **Tiny Client** - Only 466 bytes gzipped.
|
|
35
45
|
|
|
46
|
+
<br />
|
|
47
|
+
|
|
36
48
|
## Quick Start
|
|
37
49
|
```ts
|
|
38
50
|
import { connect } from 'itty-sockets' // ~466 bytes
|
|
@@ -44,6 +56,8 @@ connect('my-channel')
|
|
|
44
56
|
.send({ foo: 'bar' }) // objects
|
|
45
57
|
```
|
|
46
58
|
|
|
59
|
+
<br />
|
|
60
|
+
|
|
47
61
|
## Chat Example
|
|
48
62
|
```ts
|
|
49
63
|
import { connect } from 'itty-sockets'
|
|
@@ -60,6 +74,8 @@ bob.send('hey Alice!')
|
|
|
60
74
|
// → "Bob: hey Alice!"
|
|
61
75
|
```
|
|
62
76
|
|
|
77
|
+
<br />
|
|
78
|
+
|
|
63
79
|
## API at a Glance
|
|
64
80
|
|
|
65
81
|
| Method | Description |
|
|
@@ -73,4 +89,6 @@ bob.send('hey Alice!')
|
|
|
73
89
|
| `.close()` | Disconnect |
|
|
74
90
|
| `.remove(type, listener)` | Remove a listener |
|
|
75
91
|
|
|
76
|
-
|
|
92
|
+
<br />
|
|
93
|
+
|
|
94
|
+
## See the [full documentation](https://ittysockets.com/docs).
|