uws-react-native 0.0.9 → 0.0.10

package/lib/typescript/module/_internal/native-modules/NativeUwsReactNative.d.ts

@@ -16,6 +16,82 @@ export interface Spec extends TurboModule {
     body: unknown, contentType: string) => unknown;
     _us_listen_socket_close: (id: CodegenTypes.Int32) => void;
     _us_socket_local_port: (id: CodegenTypes.Int32) => number;
+    /**
+     * No compression (always a good idea if you operate using an efficient binary protocol)
+     */
+    DISABLED: () => number;
+    /**
+     * Zero memory overhead compression.
+     */
+    SHARED_COMPRESSOR: () => number;
+    /**
+     * Zero memory overhead decompression.
+     */
+    SHARED_DECOMPRESSOR: () => number;
+    /**
+     * Sliding dedicated compress window, requires 3KB of memory per socket
+     */
+    DEDICATED_COMPRESSOR_3KB: () => number;
+    /**
+     * Sliding dedicated compress window, requires 4KB of memory per socket
+     */
+    DEDICATED_COMPRESSOR_4KB: () => number;
+    /**
+     * Sliding dedicated compress window, requires 8KB of memory per socket
+     */
+    DEDICATED_COMPRESSOR_8KB: () => number;
+    /**
+     * Sliding dedicated compress window, requires 16KB of memory per socket
+     */
+    DEDICATED_COMPRESSOR_16KB: () => number;
+    /**
+     * Sliding dedicated compress window, requires 32KB of memory per socket
+     */
+    DEDICATED_COMPRESSOR_32KB: () => number;
+    /**
+     * Sliding dedicated compress window, requires 64KB of memory per socket
+     */
+    DEDICATED_COMPRESSOR_64KB: () => number;
+    /**
+     * Sliding dedicated compress window, requires 128KB of memory per socket
+     */
+    DEDICATED_COMPRESSOR_128KB: () => number;
+    /**
+     * Sliding dedicated compress window, requires 256KB of memory per socket
+     */
+    DEDICATED_COMPRESSOR_256KB: () => number;
+    /**
+     * Sliding dedicated decompress window, requires 32KB of memory per socket (plus about 23KB)
+     */
+    DEDICATED_DECOMPRESSOR_32KB: () => number;
+    /**
+     * Sliding dedicated decompress window, requires 16KB of memory per socket (plus about 23KB)
+     */
+    DEDICATED_DECOMPRESSOR_16KB: () => number;
+    /**
+     * Sliding dedicated decompress window, requires 8KB of memory per socket (plus about 23KB)
+     */
+    DEDICATED_DECOMPRESSOR_8KB: () => number;
+    /**
+     * Sliding dedicated decompress window, requires 4KB of memory per socket (plus about 23KB)
+     */
+    DEDICATED_DECOMPRESSOR_4KB: () => number;
+    /**
+     * Sliding dedicated decompress window, requires 2KB of memory per socket (plus about 23KB)
+     */
+    DEDICATED_DECOMPRESSOR_2KB: () => number;
+    /**
+     * Sliding dedicated decompress window, requires 1KB of memory per socket (plus about 23KB)
+     */
+    DEDICATED_DECOMPRESSOR_1KB: () => number;
+    /**
+     * Sliding dedicated decompress window, requires 512B of memory per socket (plus about 23KB)
+     */
+    DEDICATED_DECOMPRESSOR_512B: () => number;
+    /**
+     * Sliding dedicated decompress window, requires 32KB of memory per socket (plus about 23KB)
+     */
+    DEDICATED_DECOMPRESSOR: () => number;
 }
 declare const _default: Spec;
 export default _default;

package/lib/typescript/module/_internal/native-modules/NativeUwsReactNative.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NativeUwsReactNative.d.ts","sourceRoot":"","sources":["../../../../../src/_internal/native-modules/NativeUwsReactNative.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,MAAM,cAAc,CAAA;AAErB;;GAEG;AACH,MAAM,WAAW,IAAK,SAAQ,WAAW;IACxC,GAAG,EAAE;IACJ;;OAEG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,YAAY,KAClC,YAAY,CAAC,YAAY,CAAC;IAE/B,QAAQ,EAAE;IACT;;;OAGG;IACH,IAAI,EAAE,OAAO,EACb,WAAW,EAAE,MAAM,KACf,OAAO,CAAC;IAEb,uBAAuB,EAAE,CACxB,EAAE,EAAE,YAAY,CAAC,KAAK,KAElB,IAAI,CAAC;IAEV,qBAAqB,EAAE,CACtB,EAAE,EAAE,YAAY,CAAC,KAAK,KAElB,MAAM,CAAC;CACZ;;AAED,wBAEC"}
+{"version":3,"file":"NativeUwsReactNative.d.ts","sourceRoot":"","sources":["../../../../../src/_internal/native-modules/NativeUwsReactNative.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,MAAM,cAAc,CAAA;AAErB;;GAEG;AACH,MAAM,WAAW,IAAK,SAAQ,WAAW;IACxC,GAAG,EAAE;IACJ;;OAEG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,YAAY,KAClC,YAAY,CAAC,YAAY,CAAC;IAE/B,QAAQ,EAAE;IACT;;;OAGG;IACH,IAAI,EAAE,OAAO,EACb,WAAW,EAAE,MAAM,KACf,OAAO,CAAC;IAEb,uBAAuB,EAAE,CACxB,EAAE,EAAE,YAAY,CAAC,KAAK,KAElB,IAAI,CAAC;IAEV,qBAAqB,EAAE,CACtB,EAAE,EAAE,YAAY,CAAC,KAAK,KAElB,MAAM,CAAC;IAEZ;;OAEG;IACH,QAAQ,EAAE,MAAM,MAAM,CAAC;IAEvB;;OAEG;IACH,iBAAiB,EAAE,MAAM,MAAM,CAAC;IAEhC;;OAEG;IACH,mBAAmB,EAAE,MAAM,MAAM,CAAC;IAElC;;OAEG;IACH,wBAAwB,EAAE,MAAM,MAAM,CAAC;IAEvC;;OAEG;IACH,wBAAwB,EAAE,MAAM,MAAM,CAAC;IAEvC;;OAEG;IACH,wBAAwB,EAAE,MAAM,MAAM,CAAC;IAEvC;;OAEG;IACH,yBAAyB,EAAE,MAAM,MAAM,CAAC;IAExC;;OAEG;IACH,yBAAyB,EAAE,MAAM,MAAM,CAAC;IAExC;;OAEG;IACH,yBAAyB,EAAE,MAAM,MAAM,CAAC;IAExC;;OAEG;IACH,0BAA0B,EAAE,MAAM,MAAM,CAAC;IAEzC;;OAEG;IACH,0BAA0B,EAAE,MAAM,MAAM,CAAC;IAEzC;;OAEG;IACH,2BAA2B,EAAE,MAAM,MAAM,CAAC;IAE1C;;OAEG;IACH,2BAA2B,EAAE,MAAM,MAAM,CAAC;IAE1C;;OAEG;IACH,0BAA0B,EAAE,MAAM,MAAM,CAAC;IAEzC;;OAEG;IACH,0BAA0B,EAAE,MAAM,MAAM,CAAC;IAEzC;;OAEG;IACH,0BAA0B,EAAE,MAAM,MAAM,CAAC;IAEzC;;OAEG;IACH,0BAA0B,EAAE,MAAM,MAAM,CAAC;IAEzC;;OAEG;IACH,2BAA2B,EAAE,MAAM,MAAM,CAAC;IAE1C;;OAEG;IACH,sBAAsB,EAAE,MAAM,MAAM,CAAC;CACrC;;AAED,wBAEC"}

package/lib/typescript/module/modules/CompressOptions.d.ts

@@ -1 +1,82 @@
+/**
+ * WebSocket compression options. Combine any compressor with any decompressor using bitwise OR.
+ */
+export declare enum CompressOptions {
+    /**
+     * No compression (always a good idea if you operate using an efficient binary protocol)
+     */
+    DISABLED,
+    /**
+     * Zero memory overhead compression.
+     */
+    SHARED_COMPRESSOR,
+    /**
+     * Zero memory overhead decompression.
+     */
+    SHARED_DECOMPRESSOR,
+    /**
+     * Sliding dedicated compress window, requires 3KB of memory per socket
+     */
+    DEDICATED_COMPRESSOR_3KB,
+    /**
+     * Sliding dedicated compress window, requires 4KB of memory per socket
+     */
+    DEDICATED_COMPRESSOR_4KB,
+    /**
+     * Sliding dedicated compress window, requires 8KB of memory per socket
+     */
+    DEDICATED_COMPRESSOR_8KB,
+    /**
+     * Sliding dedicated compress window, requires 16KB of memory per socket
+     */
+    DEDICATED_COMPRESSOR_16KB,
+    /**
+     * Sliding dedicated compress window, requires 32KB of memory per socket
+     */
+    DEDICATED_COMPRESSOR_32KB,
+    /**
+     * Sliding dedicated compress window, requires 64KB of memory per socket
+     */
+    DEDICATED_COMPRESSOR_64KB,
+    /**
+     * Sliding dedicated compress window, requires 128KB of memory per socket
+     */
+    DEDICATED_COMPRESSOR_128KB,
+    /**
+     * Sliding dedicated compress window, requires 256KB of memory per socket
+     */
+    DEDICATED_COMPRESSOR_256KB,
+    /**
+     * Sliding dedicated decompress window, requires 32KB of memory per socket (plus about 23KB)
+     */
+    DEDICATED_DECOMPRESSOR_32KB,
+    /**
+     * Sliding dedicated decompress window, requires 16KB of memory per socket (plus about 23KB)
+     */
+    DEDICATED_DECOMPRESSOR_16KB,
+    /**
+     * Sliding dedicated decompress window, requires 8KB of memory per socket (plus about 23KB)
+     */
+    DEDICATED_DECOMPRESSOR_8KB,
+    /**
+     * Sliding dedicated decompress window, requires 4KB of memory per socket (plus about 23KB)
+     */
+    DEDICATED_DECOMPRESSOR_4KB,
+    /**
+     * Sliding dedicated decompress window, requires 2KB of memory per socket (plus about 23KB)
+     */
+    DEDICATED_DECOMPRESSOR_2KB,
+    /**
+     * Sliding dedicated decompress window, requires 1KB of memory per socket (plus about 23KB)
+     */
+    DEDICATED_DECOMPRESSOR_1KB,
+    /**
+     * Sliding dedicated decompress window, requires 512B of memory per socket (plus about 23KB)
+     */
+    DEDICATED_DECOMPRESSOR_512B,
+    /**
+     * Sliding dedicated decompress window, requires 32KB of memory per socket (plus about 23KB)
+     */
+    DEDICATED_DECOMPRESSOR
+}
 //# sourceMappingURL=CompressOptions.d.ts.map

package/lib/typescript/module/modules/CompressOptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CompressOptions.d.ts","sourceRoot":"","sources":["../../../../src/modules/CompressOptions.ts"],"names":[],"mappings":""}
+{"version":3,"file":"CompressOptions.d.ts","sourceRoot":"","sources":["../../../../src/modules/CompressOptions.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,eAAe;IAC1B;;OAEG;IACH,QAA8C;IAE9C;;OAEG;IACH,iBAA8D;IAE9D;;OAEG;IACH,mBAAkE;IAElE;;OAEG;IACH,wBAA0E;IAE1E;;OAEG;IACH,wBAA0E;IAE1E;;OAEG;IACH,wBAA0E;IAE1E;;OAEG;IACH,yBAA4E;IAE5E;;OAEG;IACH,yBAA4E;IAE5E;;OAEG;IACH,yBAA4E;IAE5E;;OAEG;IACH,0BAA8E;IAE9E;;OAEG;IACH,0BAA8E;IAE9E;;OAEG;IACH,2BAAgF;IAEhF;;OAEG;IACH,2BAAgF;IAEhF;;OAEG;IACH,0BAA8E;IAE9E;;OAEG;IACH,0BAA8E;IAE9E;;OAEG;IACH,0BAA8E;IAE9E;;OAEG;IACH,0BAA8E;IAE9E;;OAEG;IACH,2BAAgF;IAEhF;;OAEG;IACH,sBAAuE;CACvE"}

package/lib/typescript/module/types/WebSocket.d.ts

@@ -3,80 +3,71 @@ import type { RecognizedString } from "./RecognizedString";
  * A WebSocket connection that is valid from open to close event.
  * Read more about this in the user manual.
  */
-export interface WebSocket {
+export interface WebSocket<UserData> {
     /**
-     * Sends a message. Returns 1 for success, 2 for dropped due to backpressure limit, and 0 for built up backpressure that will drain over time. You can check backpressure before or after sending by calling getBufferedAmount().
-     *
-     * Make sure you properly understand the concept of backpressure. Check the backpressure example file.
+     * Forcefully closes this WebSocket. Immediately calls the close handler.
+     * No WebSocket close message is sent.
      */
-    send(message: RecognizedString, isBinary?: boolean, compress?: boolean): number;
+    close(): void;
     /**
-     * Returns the bytes buffered in backpressure. This is similar to the bufferedAmount property in the browser counterpart.
-     * Check backpressure example.
+     * See `HttpResponse.cork`.
+     * Takes a function in which the socket is corked (packing many sends into one single syscall/SSL block)
      */
-    getBufferedAmount(): number;
+    cork(cb: () => void): WebSocket<UserData>;
     /**
      * Gracefully closes this WebSocket. Immediately calls the close handler.
      * A WebSocket close message is sent with code and shortMessage.
      */
     end(code?: number, shortMessage?: RecognizedString): void;
     /**
-     * Forcefully closes this WebSocket. Immediately calls the close handler.
-     * No WebSocket close message is sent.
-     */
-    close(): void;
-    /**
-     * Sends a ping control message. Returns sendStatus similar to WebSocket.send (regarding backpressure). This helper function correlates to WebSocket::send(message, uWS::OpCode::PING, ...) in C++.
+     * Returns the bytes buffered in backpressure. This is similar to the bufferedAmount property in the browser counterpart.
+     * Check backpressure example.
      */
-    ping(message?: RecognizedString): number;
+    getBufferedAmount(): number;
     /**
-     * Subscribe to a topic.
+     * Returns the remote IP address. Note that the returned IP is binary, not text.
+     *
+     * IPv4 is 4 byte long and can be converted to text by printing every byte as a digit between 0 and 255.
+     * IPv6 is 16 byte long and can be converted to text in similar ways, but you typically print digits in HEX.
+     *
+     * See getRemoteAddressAsText() for a text version.
      */
-    subscribe(topic: RecognizedString): boolean;
+    getRemoteAddress(): ArrayBuffer;
     /**
-     * Unsubscribe from a topic. Returns true on success, if the WebSocket was subscribed.
+     * Returns the remote IP address as text.
      */
-    unsubscribe(topic: RecognizedString): boolean;
+    getRemoteAddressAsText(): string;
     /**
-     * Returns whether this websocket is subscribed to topic.
+     * Returns the remote port number.
      */
-    isSubscribed(topic: RecognizedString): boolean;
+    getRemotePort(): number;
     /**
      * Returns a list of topics this websocket is subscribed to.
      */
     getTopics(): string[];
     /**
-     * Publish a message under topic. Backpressure is managed according to maxBackpressure, closeOnBackpressureLimit settings.
-     * Order is guaranteed since v20.
-     */
-    publish(topic: RecognizedString, message: RecognizedString, isBinary?: boolean, compress?: boolean): boolean;
-    /**
-     * See `HttpResponse.cork`. Takes a function in which the socket is corked (packing many sends into one single syscall/SSL block)
+     * Returns the UserData object.
      */
-    cork(cb: () => void): WebSocket;
+    getUserData(): UserData;
     /**
-     * Returns the remote IP address. Note that the returned IP is binary, not text.
-     *
-     * IPv4 is 4 byte long and can be converted to text by printing every byte as a digit between 0 and 255.
-     * IPv6 is 16 byte long and can be converted to text in similar ways, but you typically print digits in HEX.
-     *
-     * See getRemoteAddressAsText() for a text version.
-     *
-     * @experimental It's an experimental due to unstable of ArrayBuffer support from React Native.
+     * Returns whether this websocket is subscribed to topic.
      */
-    getRemoteAddress(): ArrayBuffer;
+    isSubscribed(topic: RecognizedString): boolean;
     /**
-     * Returns the remote IP address as text.
+     * Sends a ping control message. Returns sendStatus similar to WebSocket.send (regarding backpressure). This helper function correlates to WebSocket::send(message, uWS::OpCode::PING, ...) in C++.
      */
-    getRemoteAddressAsText(): string;
+    ping(message?: RecognizedString): number;
     /**
-     * Returns the remote port number.
+     * Publish a message under topic. Backpressure is managed according to maxBackpressure, closeOnBackpressureLimit settings.
+     * Order is guaranteed since v20.
      */
-    getRemotePort(): number;
+    publish(topic: RecognizedString, message: RecognizedString, isBinary?: boolean, compress?: boolean): boolean;
     /**
-     * Returns the UserData ~object~ string.
+     * Sends a message. Returns 1 for success, 2 for dropped due to backpressure limit, and 0 for built up backpressure that will drain over time. You can check backpressure before or after sending by calling getBufferedAmount().
+     *
+     * Make sure you properly understand the concept of backpressure. Check the backpressure example file.
      */
-    getUserData(): string;
+    send(message: RecognizedString, isBinary?: boolean, compress?: boolean): number;
     /**
      * Sends the first fragment of a fragmented message. Use for sending large messages in chunks.
      * Returns 1 for success, 2 for dropped due to backpressure limit, and 0 for built up backpressure.
@@ -92,5 +83,13 @@ export interface WebSocket {
      * Returns 1 for success, 2 for dropped due to backpressure limit, and 0 for built up backpressure.
      */
     sendLastFragment(message: RecognizedString, compress?: boolean): number;
+    /**
+     * Subscribe to a topic.
+     */
+    subscribe(topic: RecognizedString): boolean;
+    /**
+     * Unsubscribe from a topic. Returns true on success, if the WebSocket was subscribed.
+     */
+    unsubscribe(topic: RecognizedString): boolean;
 }
 //# sourceMappingURL=WebSocket.d.ts.map

package/lib/typescript/module/types/WebSocket.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WebSocket.d.ts","sourceRoot":"","sources":["../../../../src/types/WebSocket.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,gBAAgB,EAChB,MAAM,oBAAoB,CAAA;AAE3B;;;GAGG;AACH,MAAM,WAAW,SAAS;IACzB;;;;OAIM;IACN,IAAI,CACH,OAAO,EAAE,gBAAgB,EACzB,QAAQ,CAAC,EAAE,OAAO,EAClB,QAAQ,CAAC,EAAE,OAAO,GACf,MAAM,CAAC;IAEX;;;OAGM;IACN,iBAAiB,IAAK,MAAM,CAAC;IAE7B;;;OAGM;IACN,GAAG,CACF,IAAI,CAAC,EAAE,MAAM,EACb,YAAY,CAAC,EAAE,gBAAgB,GAC5B,IAAI,CAAC;IAET;;;OAGM;IACN,KAAK,IAAK,IAAI,CAAC;IAEf;;OAEG;IACH,IAAI,CACH,OAAO,CAAC,EAAE,gBAAgB,GACvB,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,CACR,KAAK,EAAE,gBAAgB,GACpB,OAAO,CAAC;IAEZ;;OAEG;IACH,WAAW,CACV,KAAK,EAAE,gBAAgB,GACpB,OAAO,CAAC;IAEZ;;OAEG;IACH,YAAY,CACX,KAAK,EAAE,gBAAgB,GACpB,OAAO,CAAC;IAEZ;;OAEG;IACH,SAAS,IAAK,MAAM,EAAE,CAAC;IAEvB;;;OAGM;IACN,OAAO,CACN,KAAK,EAAE,gBAAgB,EACvB,OAAO,EAAE,gBAAgB,EACzB,QAAQ,CAAC,EAAE,OAAO,EAClB,QAAQ,CAAC,EAAE,OAAO,GACf,OAAO,CAAC;IAEZ;;OAEG;IACH,IAAI,CACH,EAAE,EAAE,MAAM,IAAI,GACX,SAAS,CAAiB;IAE9B;;;;;;;;;OASM;IACN,gBAAgB,IAAK,WAAW,CAAC;IAEjC;;OAEG;IACH,sBAAsB,IAAsB,MAAM,CAAC;IAEnD;;OAEG;IACH,aAAa,IAAK,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,IAAmB,MAAM,CAAC;IAErC;;;OAGM;IACN,iBAAiB,CAChB,OAAO,EAAE,gBAAgB,EACzB,QAAQ,CAAC,EAAE,OAAO,EAClB,QAAQ,CAAC,EAAE,OAAO,GACf,MAAM,CAAC;IAEX;;;OAGM;IACN,YAAY,CACX,OAAO,EAAE,gBAAgB,EACzB,QAAQ,CAAC,EAAE,OAAO,GACf,MAAM,CAAC;IAEX;;;OAGM;IACN,gBAAgB,CACf,OAAO,EAAE,gBAAgB,EACzB,QAAQ,CAAC,EAAE,OAAO,GACf,MAAM,CAAC;CACX"}
+{"version":3,"file":"WebSocket.d.ts","sourceRoot":"","sources":["../../../../src/types/WebSocket.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,gBAAgB,EAChB,MAAM,oBAAoB,CAAA;AAE3B;;;GAGG;AACH,MAAM,WAAW,SAAS,CAAC,QAAQ;IAClC;;;OAGM;IACN,KAAK,IAAK,IAAI,CAAC;IAEf;;;OAGG;IACH,IAAI,CACH,EAAE,EAAE,MAAM,IAAI,GACX,SAAS,CAAC,QAAQ,CAAC,CAAC;IAExB;;;OAGM;IACN,GAAG,CACF,IAAI,CAAC,EAAE,MAAM,EACb,YAAY,CAAC,EAAE,gBAAgB,GAC5B,IAAI,CAAC;IAET;;;OAGM;IACN,iBAAiB,IAAK,MAAM,CAAC;IAE7B;;;;;;;OAOM;IACN,gBAAgB,IAAK,WAAW,CAAC;IAEjC;;OAEG;IACH,sBAAsB,IAAK,MAAM,CAAC;IAElC;;OAEG;IACH,aAAa,IAAK,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,IAAK,MAAM,EAAE,CAAC;IAEvB;;OAEG;IACH,WAAW,IAAK,QAAQ,CAAC;IAEzB;;OAEG;IACH,YAAY,CACX,KAAK,EAAE,gBAAgB,GACpB,OAAO,CAAC;IAEZ;;OAEG;IACH,IAAI,CACH,OAAO,CAAC,EAAE,gBAAgB,GACvB,MAAM,CAAC;IAEX;;;OAGM;IACN,OAAO,CACN,KAAK,EAAE,gBAAgB,EACvB,OAAO,EAAE,gBAAgB,EACzB,QAAQ,CAAC,EAAE,OAAO,EAClB,QAAQ,CAAC,EAAE,OAAO,GACf,OAAO,CAAC;IAEZ;;;;OAIM;IACN,IAAI,CACH,OAAO,EAAE,gBAAgB,EACzB,QAAQ,CAAC,EAAE,OAAO,EAClB,QAAQ,CAAC,EAAE,OAAO,GACf,MAAM,CAAC;IAEX;;;OAGM;IACN,iBAAiB,CAChB,OAAO,EAAE,gBAAgB,EACzB,QAAQ,CAAC,EAAE,OAAO,EAClB,QAAQ,CAAC,EAAE,OAAO,GACf,MAAM,CAAC;IAEX;;;OAGM;IACN,YAAY,CACX,OAAO,EAAE,gBAAgB,EACzB,QAAQ,CAAC,EAAE,OAAO,GACf,MAAM,CAAC;IAEX;;;OAGM;IACN,gBAAgB,CACf,OAAO,EAAE,gBAAgB,EACzB,QAAQ,CAAC,EAAE,OAAO,GACf,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,CACR,KAAK,EAAE,gBAAgB,GACpB,OAAO,CAAC;IAEZ;;OAEG;IACH,WAAW,CACV,KAAK,EAAE,gBAAgB,GACpB,OAAO,CAAC;CACZ"}

package/lib/typescript/module/types/WebSocketBehavior.d.ts

@@ -0,0 +1,101 @@
+import type { CompressOptions } from "../modules/CompressOptions";
+import type { HttpRequest } from "./HttpRequest";
+import type { HttpResponse } from "./HttpResponse";
+import type { WebSocket } from "./WebSocket";
+import type { us_socket_context_t } from "./us_socket_context_t";
+/**
+ * A structure holding settings and handlers for a WebSocket URL route handler.
+ */
+export interface WebSocketBehavior<UserData> {
+    /**
+     * Handler for close event, no matter if error, timeout or graceful close.
+     * You may not use WebSocket after this event.
+     * Do not send on this WebSocket from within here, it is closed.
+     */
+    close?: (ws: WebSocket<UserData>, code: number, message: ArrayBuffer) => void;
+    /**
+     * Whether or not we should automatically close the socket when a message is dropped due to backpressure. Defaults to false.
+     */
+    closeOnBackpressureLimit?: boolean;
+    /**
+     * What permessage-deflate compression to use. uWS.DISABLED, uWS.SHARED_COMPRESSOR or any of the uWS.DEDICATED_COMPRESSOR_xxxKB. Defaults to uWS.DISABLED.
+     *
+     * Combine any compressor with any decompressor using bitwise OR.
+     */
+    compression?: CompressOptions;
+    /**
+     * Handler for when WebSocket backpressure drains.
+     * Check `ws.getBufferedAmount()`.
+     * Use this to guide / drive your backpressure throttling.
+     */
+    drain?: (ws: WebSocket<UserData>) => void;
+    /**
+     * Handler for a dropped WebSocket message.
+     * Messages can be dropped due to specified backpressure settings.
+     * Messages are given as ArrayBuffer no matter if they are binary or not.
+     * Given ArrayBuffer is valid during the lifetime of this callback
+     * (until first await or return) and will be neutered.
+     */
+    dropped?: (ws: WebSocket<UserData>, message: ArrayBuffer, isBinary: boolean) => void | Promise<void>;
+    /**
+     * Maximum amount of seconds that may pass without sending or getting a message. Connection is closed if this timeout passes.
+     * Resolution (granularity) for timeouts are typically 4 seconds, rounded to closest.
+     *
+     * Disable by using 0. Defaults to 120.
+     */
+    idleTimeout?: number;
+    /**
+     * Maximum length of allowed backpressure per socket when publishing or sending messages.
+     * Slow receivers with too high backpressure will be skipped until they catch up or timeout.
+     *
+     * Defaults to 64 * 1024.
+     */
+    maxBackpressure?: number;
+    /**
+     * Maximum number of minutes a WebSocket may be connected before being closed by the server.
+     *
+     * 0 disables the feature. Valid values are 0 and 1-239.
+     */
+    maxLifetime?: number;
+    /**
+     * Maximum length of received message.
+     * If a client tries to send you a message larger than this, the connection is immediately closed.
+     *
+     * Defaults to 16 * 1024.
+     */
+    maxPayloadLength?: number;
+    /**
+     * Handler for a WebSocket message.
+     * Messages are given as ArrayBuffer no matter if they are binary or not.
+     *
+     * Given ArrayBuffer is valid during the lifetime of this callback (until first await or return) and will be neutered.
+     */
+    message?: (ws: WebSocket<UserData>, message: ArrayBuffer, isBinary: boolean) => void | Promise<void>;
+    /**
+     * Handler for new WebSocket connection.
+     * WebSocket is valid from open to close, no errors.
+     */
+    open?: (ws: WebSocket<UserData>) => void | Promise<void>;
+    /**
+     * Handler for received ping control message.
+     * You do not need to handle this, pong messages are automatically sent as per the standard.
+     */
+    ping?: (ws: WebSocket<UserData>, message: ArrayBuffer) => void;
+    /**
+     * Handler for received pong control message.
+     */
+    pong?: (ws: WebSocket<UserData>, message: ArrayBuffer) => void;
+    /**
+     * Whether or not we should automatically send pings to uphold a stable connection given whatever `idleTimeout`.
+     */
+    sendPingsAutomatically?: boolean;
+    /**
+     * Handler for subscription changes.
+     */
+    subscription?: (ws: WebSocket<UserData>, topic: ArrayBuffer, newCount: number, oldCount: number) => void;
+    /**
+     * Upgrade handler used to intercept HTTP upgrade requests and potentially upgrade to WebSocket.
+     */
+    upgrade?: (res: HttpResponse, req: HttpRequest, context: us_socket_context_t) => void | Promise<void>;
+}
+//# sourceMappingURL=WebSocketBehavior.d.ts.map

package/lib/typescript/module/types/WebSocketBehavior.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebSocketBehavior.d.ts","sourceRoot":"","sources":["../../../../src/types/WebSocketBehavior.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,eAAe,EACf,MAAM,4BAA4B,CAAA;AAEnC,OAAO,KAAK,EACX,WAAW,EACX,MAAM,eAAe,CAAA;AAEtB,OAAO,KAAK,EACX,YAAY,EACZ,MAAM,gBAAgB,CAAA;AAEvB,OAAO,KAAK,EACX,SAAS,EACT,MAAM,aAAa,CAAA;AAEpB,OAAO,KAAK,EACX,mBAAmB,EACnB,MAAM,uBAAuB,CAAA;AAE9B;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,QAAQ;IAC1C;;;;OAIG;IACH,KAAK,CAAC,EAAE,CACP,EAAE,EAAE,SAAS,CAAC,QAAQ,CAAC,EACvB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,WAAW,KAChB,IAAI,CAAC;IAEV;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;;OAIG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;IAE9B;;;;OAIG;IACH,KAAK,CAAC,EAAE,CACP,EAAE,EAAE,SAAS,CAAC,QAAQ,CAAC,KACnB,IAAI,CAAC;IAEV;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,CACT,EAAE,EAAE,SAAS,CAAC,QAAQ,CAAC,EACvB,OAAO,EAAE,WAAW,EACpB,QAAQ,EAAE,OAAO,KACb,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,CACT,EAAE,EAAE,SAAS,CAAC,QAAQ,CAAC,EACvB,OAAO,EAAE,WAAW,EACpB,QAAQ,EAAE,OAAO,KACb,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1B;;;OAGG;IACH,IAAI,CAAC,EAAE,CACN,EAAE,EAAE,SAAS,CAAC,QAAQ,CAAC,KACnB,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1B;;;OAGG;IACH,IAAI,CAAC,EAAE,CACN,EAAE,EAAE,SAAS,CAAC,QAAQ,CAAC,EACvB,OAAO,EAAE,WAAW,KAChB,IAAI,CAAC;IAEV;;OAEG;IACH,IAAI,CAAC,EAAE,CACN,EAAE,EAAE,SAAS,CAAC,QAAQ,CAAC,EACvB,OAAO,EAAE,WAAW,KAChB,IAAI,CAAC;IAEV;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,YAAY,CAAC,EAAE,CACd,EAAE,EAAE,SAAS,CAAC,QAAQ,CAAC,EACvB,KAAK,EAAE,WAAW,EAClB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,KACZ,IAAI,CAAC;IAEV;;OAEG;IACH,OAAO,CAAC,EAAE,CACT,GAAG,EAAE,YAAY,EACjB,GAAG,EAAE,WAAW,EAChB,OAAO,EAAE,mBAAmB,KACxB,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1B"}