Add websocket library support

ItemConsulting · Sep 11, 2020 · 7d0e743 · 7d0e743
1 parent 52e7d9e
commit 7d0e743
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 3 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "enonic-types",
   "sideEffects": false,
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "TypeScript types for Enonic XP",
   "typings": "index.d.ts",
   "scripts": {

diff --git a/src/websocket.ts b/src/websocket.ts
@@ -0,0 +1,21 @@
+export interface WebsocketLibrary {
+  /**
+   * Add an id to a socket group.
+   */
+  addToGroup(group: string, id: string): void;
+
+  /**
+   * Remove an id from a socket group.
+   */
+  removeFromGroup(group: string, id: string): void;
+
+  /**
+   * Send message directly to a socket id.
+   */
+  send(id: string, message: string): void;
+
+  /**
+   * Send message to all sockets in group.
+   */
+  sendToGroup(group: string, message: string): void;
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -7,7 +7,8 @@
     "module": "commonjs",
     "moduleResolution": "node",
     "strict": true,
-    "lib": ["es6"]
+    "lib": ["es6"],
+    "removeComments": false
   },
   "include": ["./src/**/*"],
   "exclude": [