From ea27aa07500cc0a719af65be845fcd9480eb1bc8 Mon Sep 17 00:00:00 2001
From: Tim Holm <tim.holm@nitric.io>
Date: Tue, 11 Jul 2023 10:55:23 +1000
Subject: [PATCH] update jsdoc

---
 src/resources/websocket.ts | 13 ++++++-------
 1 file changed, 6 insertions(+), 7 deletions(-)

diff --git a/src/resources/websocket.ts b/src/resources/websocket.ts
index 11595942..c5a37755 100644
--- a/src/resources/websocket.ts
+++ b/src/resources/websocket.ts
@@ -65,7 +65,7 @@ export class Websocket {
 }
 
 /**
- * Cloud storage bucket resource for large file storage.
+ * Websocket resource for bi-di HTTP communication.
  */
 export class WebsocketResource extends Base<any> {
   private readonly wsClient: WsClient;
@@ -76,7 +76,7 @@ export class WebsocketResource extends Base<any> {
   }
 
   /**
-   * Register this bucket as a required resource for the calling function/container.
+   * Register this websocket as a required resource for the calling function/container.
    *
    * @returns a promise that resolves when the registration is complete
    */
@@ -137,9 +137,9 @@ export class WebsocketResource extends Base<any> {
   }
 
   /**
-   * Retrieves the Invocation URL of this API at runtime.
+   * Retrieves the Invocation URL of this Websocket at runtime.
    *
-   * @returns Promise that returns the URL of this API
+   * @returns Promise that returns the URL of this Websocket
    */
   async url(): Promise<string> {
     const {
@@ -150,10 +150,9 @@ export class WebsocketResource extends Base<any> {
   }
 
   /**
-   * Register and start a bucket notification handler that will be called for all matching notification events on this bucket
+   * Register and start a websocket event handler that will be called for all matching events on this websocket
    *
-   * @param notificationType the notification type that should trigger the middleware, either 'write' or 'delete'
-   * @param notificationPrefixFilter the file name prefix that files must match to trigger a notification
+   * @param eventType the notification type that should trigger the middleware, either 'connect', 'disconnect' or 'message'
    * @param middleware handler middleware which will be run for every incoming event
    * @returns Promise which resolves when the handler server terminates
    */