itty-sockets 0.2.1 → 0.2.3

package/README.md

@@ -16,9 +16,9 @@
 
 ---
 
-Tiny messaging client in under 450 bytes.  No backend needed.
+Tiny realtime messaging client in under 450 bytes.  No backend needed.
 
-## Example (using ittysockets.io public channels)
+## Example (using [ittysockets.io](https://ittysockets.io) public channels)
 ```ts
 import { connect } from 'itty-sockets' // ~422 bytes
 
@@ -86,9 +86,9 @@ connect('foo').push('hello world!')
 | **connect(id, options)** | Creates a new channel connection | `connect('foo')` |
 | **.open()** | Opens/re-opens the connection (manually, usually not needed) | `channel.open()` |
 | **.close()** | Closes the connection | `channel.close()` |
-| **.send(message)** | Sends a message to the room | `channel.send({ type: 'chat', text: 'hello' })` |
+| **.send(message)** | Sends a message to the channel | `channel.send({ type: 'chat', text: 'hello' })` |
 | **.push(message)** | Sends a message and closes the connection | `channel.push({ type: 'goodbye' })` |
-| **.on('message', listener)** | Adds a message listener (multiple allowed) | `channel.on('message', event => console.log(event))` |
+| **.on<MessageType = any>('message', listener)** | Adds a message listener (multiple allowed) | `channel.on('message', event => console.log(event))` |
 | **.on('open', listener)** | Executes a listener on channel open (one allowed) | `channel.on('open', () => console.log('channel opened'))` |
 | **.on('close', listener)** | Executes a listener on channel close (one allowed) | `channel.on('close', () => console.log('channel closed'))` |
 

package/connect.d.ts

@@ -1,4 +1,5 @@
 export type AllowedProperty = 'open' | 'close' | 'send' | 'push' | 'on';
+export type IttySocketEvent = 'open' | 'close' | 'message';
 export type MessageEvent<MessageType = any> = {
     date: Date;
     uid?: string;
@@ -12,7 +13,8 @@ export type IttySocket = {
     connected: boolean;
     send: SendMessage;
     push: SendMessage;
-    on: <T extends string, MessageType = any>(type: T, listener: T extends 'message' ? (event: MessageEvent<MessageType>) => any : () => any) => IttySocket;
+    on<MessageFormat = any>(type: 'message', listener: (event: MessageEvent<MessageFormat>) => any): IttySocket;
+    on(type: Exclude<IttySocketEvent, 'message'>, listener: () => any): IttySocket;
 };
 export type IttySocketOptions = {
     as?: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "itty-sockets",
-  "version": "0.2.1",
-  "description": "An easier way to handle WebSockets, in an itty package.",
+  "version": "0.2.3",
+  "description": "Tiny realtime messaging client in under 450 bytes.  No backend needed.",
   "main": "./sockets.js",
   "module": "./sockets.mjs",
   "types": "./sockets.d.ts",
@@ -19,6 +19,9 @@
   "keywords": [
     "websockets",
     "realtime",
+    "public",
+    "messages",
+    "tiny",
     "free",
     "p2p"
   ],