@azure/web-pubsub-express 1.0.0-beta.4 → 1.0.1-alpha.20220118.1

package/types/web-pubsub-express.d.ts

@@ -158,7 +158,20 @@ export declare type UserEventRequest = {
     /**
      * The type of the data.
      */
-    dataType: "text" | "json";
+    dataType: "text";
+} | {
+    /**
+     * The context of current CloudEvents request.
+     */
+    context: ConnectionContext;
+    /**
+     * The content data, when data type is `json`, the data is the result of JSON.parse, so the type of the data depends on user scenarios
+     */
+    data: unknown;
+    /**
+     * The type of the data.
+     */
+    dataType: "json";
 } | {
     /**
      * The context of current CloudEvents request.
@@ -186,7 +199,7 @@ export declare interface UserEventResponseHandler {
     setState(name: string, value: unknown): void;
     /**
      * Return success response with data to be delivered to the client WebSocket connection.
-     * @param data - The payload data to be returned to the client.
+     * @param data - The payload data to be returned to the client. Stringify the message if it is a JSON object.
      * @param dataType - The type of the payload data.
      */
     success(data?: string | ArrayBuffer, dataType?: "binary" | "text" | "json"): void;