@typetron/websockets 0.3.2 → 0.3.7

package/Readme.md

@@ -1,7 +1,29 @@
-# Typetron Angular utilities
+# Typetron WebSockets
 
-**[Typetron](https://typetron.org)** is a **modern web framework** built for Node.js, written in **Typescript**, that
-allows you to build fully featured web applications.
+This library is used to easily listen and emit WebSockets event
+from the browser client to a Typetron app.
 
-This package contains a set of utilities used in frontend apps when working with Typetron in order to easily connect to
-websockets. More about it at [https://typetron.org](https://typetron.org/frontend/websockets)
+#### Connecting to WebSockets
+```ts
+import { Websocket } from '@typetron/websockets'
+export const socket = new Websocket('ws://localhost:8001')
+```
+
+
+#### Listening for events
+```ts
+socket.on('eventName').subscribe(response => {
+    console.log('Backend response', response)
+})
+```
+
+#### Emitting events
+```ts
+socket.emit('eventName');
+```
+
+#### Emitting and listening for backend response
+```ts
+const users = await socket.request('users.list')
+const savedUser = await socket.request('users.save', {name: 'John'})
+```

package/package.json

@@ -2,7 +2,7 @@
 	"name": "@typetron/websockets",
 	"description": "Typetron Websockets library",
 	"license": "MIT",
-	"version": "0.3.2",
+	"version": "0.3.7",
 	"author": {
 		"email": "ionel@typetron.org",
 		"name": "Ionel Lupu"
@@ -15,7 +15,7 @@
 	},
 	"dependencies": {
 		"rxjs": "^6.6.7",
-		"@typetron/framework": "^0.3.4"
+		"@typetron/framework": "^0.3.7"
 	},
 	"devDependencies": {
 		"typescript": "4.1.6"