itty-sockets 0.9.1 → 0.9.3

package/README.md

@@ -14,7 +14,7 @@
 [![Issues](https://img.shields.io/github/issues/kwhitley/itty-sockets?style=flat-square)](https://github.com/kwhitley/itty-sockets/issues)
 [![Discord](https://img.shields.io/discord/832353585802903572?label=Discord&logo=Discord&style=flat-square&logoColor=fff)](https://discord.gg/53vyrZAu9u)
 
-### [Full Documentation](https://itty.ws/docs)  |   [Discord](https://discord.gg/53vyrZAu9u)
+### [Full Documentation](https://ittysockets.com/docs)  |   [Discord](https://discord.gg/53vyrZAu9u)
 
 ---
 
@@ -26,56 +26,65 @@ No accounts, no API keys, nothing to deploy. Just connect and start sending.
 
 <br />
 
-> 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.
+> After building realtime apps for 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.
 >
 > Welcome to `itty-sockets`!
->
-> ~ Kevin W
 
 <br />
 
 ## Features
-- **Zero Configuration** - No accounts, no API keys, no server. Pick a channel name and you're live.
-- **Zero Cost** - No tiers. No credit card. Built for the community.
-- **Private by Default** - No logging, no tracking, no storage. Messages are relayed and forgotten.
-- **Send Anything** - Strings, objects, arrays — anything JSON-serializable.
+- **Zero Config/Cost** - No accounts, no API keys, no server. Pick a channel name and you're live.
+- **Private** - No logging, no tracking, no storage. Messages are relayed and forgotten.
+- **Flexible** - Send any JSON-serializable data/shape.
 - **Access Control** - [Reserve a namespace](https://ittysockets.com/reservations) to control who can join or send on your channels.
 - **Use Anywhere** - No vendor lock. This client works with *any* WebSocket server.  Want to host your own?  No problem.
 - **Tiny Client** - Only 466 bytes gzipped.
 
 <br />
 
-## Quick Start
+## Chat Example
 ```ts
 import { connect } from 'itty-sockets' // ~466 bytes
 
-connect('my-channel')
-  .on('message', ({ message }) => console.log(message))
-  .send('hello world')   // strings
-  .send([1, 2, 3])       // arrays
-  .send({ foo: 'bar' })  // objects
+// connect to a room
+const bob = connect('my-secret-chat-room', { as: 'Bob' })
+
+bob
+  .send('hey Alice!')
+  .send([1, 2, 3])
+  .send({ foo: 'bar' })
 ```
 
-<br />
+meanwhile, elsewhere...
 
-## Chat Example
 ```ts
-import { connect } from 'itty-sockets'
-
-// two users, same channel
-const alice = connect('chat-room', { as: 'Alice' })
-const bob   = connect('chat-room', { as: 'Bob' })
-
-alice.on('message', ({ message, alias }) =>
-  console.log(`${alias}: ${message}`)
-)
+// connect to the same room as above, and listen for messages
+const alice = connect('my-secret-chat-room', { as: 'Alice' })
+  .on('message', ({ message, alias }) =>
+    console.log(`${alias}: ${message}`)
+  )
 
-bob.send('hey Alice!')
 // → "Bob: hey Alice!"
+// → "Bob: [1, 2, 3]"
+// → "Bob: { foo: 'bar' }"
 ```
 
 <br />
 
+## Installation
+
+```bash
+npm install itty-sockets
+```
+
+Or just paste the following snippet (loses TypeScript support):
+<!-- BEGIN SNIPPET -->
+```ts
+let connect=(e,s={})=>{let a,t,n=[],p={},o=()=>(a||(a=new WebSocket((/^wss?:/.test(e)?e:"wss://itty.ws/c/"+e)+"?"+new URLSearchParams(s)),a.onmessage=(e,s=JSON.parse(e.data),a=s?.message,t={...null==a?.[0]&&a,...s})=>[t.type,s.type?0:"message","*"].map(e=>p[e]?.map(e=>e(t))),a.onopen=()=>(n.splice(0).map(e=>a.send(e)),p.open?.map(e=>e(t)),t&&a?.close()),a.onclose=()=>(t=a=null,p.close?.map(e=>e(t)))),l),l={open:o,send:(e,s)=>(e=(s?`${s}`:"")+JSON.stringify(e),1&a?.readyState?a.send(e):n.push(e),o()),on:(e,s)=>((p[e?.[0]?e:"*"]??=[]).push(e?.[0]?s:a=>e?.(a)&&s(a)),o()),remove:(e,s)=>(p[e]=p[e]?.filter(e=>e!=s),l),close:()=>(1&a?.readyState?a.close():t=1,l),push:(e,s)=>(t=1,l.send(e,s))};return l};
+```
+<!-- END SNIPPET -->
+
+
 ## API at a Glance
 
 | Method | Description |
@@ -84,7 +93,7 @@ bob.send('hey Alice!')
 | `.on(type, listener)` | Listen for events (`'message'`, `'join'`, `'leave'`, `'open'`, `'close'`, `'error'`, custom types, or `'*'`) |
 | `.on(filterFn, listener)` | Listen with a custom filter function |
 | `.send(message, uid?)` | Send a message (optionally to a specific user) |
-| `.push(message, uid?)` | Send a message and disconnect |
+| `.push(message, uid?)` | Send a message and disconnect afterwards |
 | `.open()` | (Re)connect — safe to call anytime, listeners are preserved |
 | `.close()` | Disconnect |
 | `.remove(type, listener)` | Remove a listener |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "itty-sockets",
-  "version": "0.9.1",
+  "version": "0.9.3",
   "description": "WebSockets : simplified and minified.",
   "type": "module",
   "exports": {
@@ -21,7 +21,8 @@
   "keywords": [
     "websockets",
     "realtime",
-    "client"
+    "client",
+    "zero-config"
   ],
   "repository": {
     "type": "git",