@ublitzjs/core 0.1.1 → 1.0.1

package/dist/types/index.d.ts

@@ -0,0 +1,249 @@
+import type { BaseHeaders, lowHeaders } from "./http-headers.js";
+import { Buffer } from "node:buffer";
+import { EventEmitter } from "tseep";
+import type { CompressOptions, WebSocket, HttpRequest as uwsHttpRequest, TemplatedApp, HttpResponse as uwsHttpResponse, RecognizedString, us_socket_context_t } from "uWebSockets.js";
+/**
+ * function to effortlessly mark response as aborted AND to attach an event emitter, so that you can easily scale the handler. If you don't need event emitter and only some res.aborted - set it by yourself (no overkill for the handler)
+ * @param res
+ */
+export declare function registerAbort(res: uwsHttpResponse): HttpResponse;
+/**
+ * An extended version of uWS.App . It provides you with several features:
+ * 1) plugin registration (just like in Fastify);
+ * 2) "ready" function and _startPromises array (use it to make your code more asynchronous and safe)
+ * 3) "route" function for more descriptive adn extensible way of registering handlers
+ * 4) "onError" function (mainly used by @ublitzjs/router)
+ */
+export interface Server extends TemplatedApp {
+    /**
+     * It is same as plugins in Fastify -> you register some functionality in separate function
+     * @param plugin
+     * @returns itself (for chaining methods)
+     */
+    register(plugin: (server: this) => void): this;
+    /** set global _errHandler (in fact it is used only by @ublitzjs/router) */
+    onError(fn: (error: Error, res: HttpResponse, data: any) => any): this;
+    _errHandler?(error: Error, res: HttpResponse, data: any): any;
+    /**some undocumented property in uWS - get it here */
+    addChildAppDescriptor(...any: any[]): this;
+    /**a function, which pushes promises to be awaited using "await server.ready()"*/
+    awaitLater(...promises: Promise<any>[]): void;
+    /**a function, which awaits all promises inside _startPromises array and then clears it*/
+    ready: () => Promise<any[]>;
+    /**
+     * simple array of promises. You can push several inside and await all of them using server.ready() method
+     */
+    _startPromises: Promise<any>[];
+    /**
+     * this function allows you to create new handlers but more dynamically than uWS. Best use case - development. By default, the first param you pass includes a method, path, and a controller. However you can configure it for additional properties, which can be consumed on startup by second param - plugins
+     * @example
+     * server.route<onlyHttpMethods, {deprecated:boolean}>({
+     *   method:"any",
+     *   path: "/",
+     *   controller(res){ res.end("hello") },
+     *   deprecated:true
+     * },
+     * [
+     *   (opts)=>{
+     *     if(opts.deprecated) console.error("DEPRECATION FOUND", opts.path)
+     *   }
+     * ])
+     */
+    route<T extends HttpMethods, obj extends object = {}>(opts: routeFNOpts<T> & obj, plugins?: ((param: typeof opts, server: this) => void)[]): this;
+    get(pattern: RecognizedString, handler: HttpControllerFn): this;
+    post(pattern: RecognizedString, handler: HttpControllerFn): this;
+    options(pattern: RecognizedString, handler: HttpControllerFn): this;
+    del(pattern: RecognizedString, handler: HttpControllerFn): this;
+    patch(pattern: RecognizedString, handler: HttpControllerFn): this;
+    put(pattern: RecognizedString, handler: HttpControllerFn): this;
+    head(pattern: RecognizedString, handler: HttpControllerFn): this;
+    connect(pattern: RecognizedString, handler: HttpControllerFn): this;
+    trace(pattern: RecognizedString, handler: HttpControllerFn): this;
+    any(pattern: RecognizedString, handler: HttpControllerFn): this;
+    ws<UserData>(pattern: RecognizedString, behavior: DocumentedWSBehavior<UserData>): this;
+}
+export type routeFNOpts<T extends HttpMethods> = {
+    method: T;
+    path: RecognizedString;
+    controller: T extends "ws" ? DocumentedWSBehavior<any> : HttpControllerFn;
+};
+/**
+ * Utility for making closures. Exists for organizing code and caching values in non-global scope.
+ * @param param
+ * @returns what you passed
+ */
+export declare var closure: <T>(param: () => T) => T;
+/**
+ * little more typed response which has:
+ * 1) "emitter", that comes from "tseep" package
+ * 2) "aborted" flag
+ * 3) "finished" flag
+ * 4) "collect" function, which comes from original uWS (and isn't documented), but the purpose remains unknown
+ * 5) "upgrade" function, though comes from original uWS, must not contain any names, which "DocumentedWS" has (or websocket object). ws.getUserData() return "ws" itself, so setting any data, which overlaps with already existing will impact your workflow. µBlitz.js doesn't add any lsp help here because it will brake "extends uwsHttpResponse" part.
+ */
+export interface HttpResponse<UserDataForWS = {}> extends uwsHttpResponse {
+    upgrade<UserData = UserDataForWS>(userData: UserData, secWebSocketKey: RecognizedString, secWebSocketProtocol: RecognizedString, secWebSocketExtensions: RecognizedString, context: us_socket_context_t): void;
+    /**
+     * This method actually exists in original uWebSockets.js, but is undocumented. I'll put it here for your IDE to be happy
+     */
+    collect: (...any: any[]) => any;
+    /**
+     * An event emitter, which lets you subscribe several listeners to "abort" event OR your own events, defined with Symbol().
+     */
+    emitter: EventEmitter<{
+        abort: () => void;
+        [k: symbol]: (...any: any[]) => void;
+    }>;
+    /**
+     * changes when res.onAborted fires.
+     */
+    aborted?: boolean;
+    /**
+     * You should set it manually when ending the response. Particularly useful if some error has fired and you are doubting whether res.aborted is a sufficient flag.
+     */
+    finished?: boolean;
+}
+/**This HttpRequest is same as original uWS.HttpRequest, but getHeader method is typed for additional tips
+ * @example
+ * import {lowHeaders} from "@ublitzjs/core"
+ * // some handler later
+ * req.getHeader<lowHeaders>("content-type")
+ */
+export interface HttpRequest extends uwsHttpRequest {
+    getHeader<T extends RecognizedString = lowHeaders>(a: T): string;
+}
+export type HttpControllerFn = (res: HttpResponse, req: HttpRequest) => any | Promise<any>;
+/**
+ * only http methods without "ws"
+ */
+export type onlyHttpMethods = "get" | "post" | "del" | "patch" | "put" | "head" | "trace" | "options" | "connect" | "any";
+/**
+ * all httpMethods with "ws" method
+ */
+export type HttpMethods = onlyHttpMethods | "ws";
+type MergeObjects<T extends any[]> = T extends [infer First, ...infer Rest] ? First & MergeObjects<Rest extends any[] ? Rest : []> : {};
+/**
+ * extends uWS.App() or uWS.SSLApp. See interface Server
+ * @param app uWS.App()
+ */
+export declare function extendApp<T extends object[]>(app: TemplatedApp, ...rest: T): Server & MergeObjects<T>;
+/**
+ * conversion to ArrayBuffer ('cause transferring strings to uWS is really slow)
+ */
+export declare function toAB(data: Buffer | string): ArrayBuffer;
+/**
+ * Thanks to "acarstoiu" github user for listing such methods here: "https://github.com/uNetworking/uWebSockets.js/issues/1165".
+ */
+type WebSocketFragmentation = {
+    /** Sends the first frame of a multi-frame message. More fragments are expected (possibly none), followed by a last fragment. Care must be taken so as not to interleave these fragments with whole messages (sent with WebSocket.send) or with other messages' fragments.
+     *
+     * 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.
+     */
+    sendFirstFragment(message: RecognizedString, isBinary?: boolean, compress?: boolean): number;
+    /** Sends a continuation frame of a multi-frame message. More fragments are expected (possibly none), followed by a last fragment. In terms of sending data, a call to this method must follow a call to WebSocket.sendFirstFragment.
+     *
+     * 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.
+     */
+    sendFragment(message: RecognizedString, compress?: boolean): number;
+    /** Sends the last continuation frame of a multi-frame message. In terms of sending data, a call to this method must follow a call to WebSocket.sendFirstFragment or WebSocket.sendFragment.
+     *
+     * 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.
+     */
+    sendLastFragment(message: RecognizedString, compress?: boolean): number;
+};
+export interface DocumentedWS<UserData> extends WebSocket<UserData>, WebSocketFragmentation {
+    /**
+     * this is an additional property, which saves you from server crashing. In "close" handler you should add "ws.closed = true" and each time you perform any asynchronous work before sending a message run a check "if(ws.closed) { cleanup and quit }"
+     * @example
+     * import {setTimeout} from "node:timers/promises"
+     * server.ws("/", {
+     *    close(ws){
+     *      ws.closed = true;
+     *    },
+     *    async message(ws){
+     *      await setTimeout(100); // simulate some db query
+     *      if(!ws.closed) ws.send("handled message", false)
+     *    }
+     * })
+    * */
+    closed: boolean;
+    /**
+    * an additional property which might save websocket from overexhaustion
+    * */
+    drainEvent: Promise<void> | undefined;
+    /**
+     * an additional property to monitor queued messages, which can't be sent due to overexhaustion (need to wait for drain).
+     **/
+    queue: number;
+}
+export interface DocumentedWSBehavior<UserData> {
+    /** 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;
+    /** Whether or not we should automatically close the socket when a message is dropped due to backpressure. Defaults to false. */
+    closeOnBackpressureLimit?: boolean;
+    /** Maximum number of minutes a WebSocket may be connected before being closed by the server. 0 disables the feature. */
+    maxLifetime?: number;
+    /** 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;
+    /** What permessage-deflate compression to use. uWS.DISABLED, uWS.SHARED_COMPRESSOR or any of the uWS.DEDICATED_COMPRESSOR_xxxKB. Defaults to uWS.DISABLED. */
+    compression?: CompressOptions;
+    /** 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;
+    /** Whether or not we should automatically send pings to uphold a stable connection given whatever idleTimeout. */
+    sendPingsAutomatically?: boolean;
+    /** Handler for new WebSocket connection. WebSocket is valid from open to close, no errors. */
+    open?: (ws: DocumentedWS<UserData>) => void | Promise<void>;
+    /** 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: DocumentedWS<UserData>, message: ArrayBuffer, isBinary: boolean) => void | Promise<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: DocumentedWS<UserData>, message: ArrayBuffer, isBinary: boolean) => void | Promise<void>;
+    /** Handler for when WebSocket backpressure drains. Check ws.getBufferedAmount(). Use this to guide / drive your backpressure throttling. */
+    drain?: (ws: DocumentedWS<UserData>) => void;
+    /** 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: DocumentedWS<UserData>, code: number, message: ArrayBuffer) => 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: DocumentedWS<UserData>, message: ArrayBuffer) => void;
+    /** Handler for received pong control message. */
+    pong?: (ws: DocumentedWS<UserData>, message: ArrayBuffer) => void;
+    /** Handler for subscription changes. */
+    subscription?: (ws: DocumentedWS<UserData>, topic: ArrayBuffer, newCount: number, oldCount: number) => void;
+    /** Upgrade handler used to intercept HTTP upgrade requests and potentially upgrade to WebSocket.
+     * See UpgradeAsync and UpgradeSync example files.
+     */
+    upgrade?: (res: HttpResponse<UserData>, req: HttpRequest, context: us_socket_context_t) => void | Promise<void>;
+}
+export type DeclarativeResType = {
+    writeHeader(key: string, value: string): DeclarativeResType;
+    writeQueryValue(key: string): DeclarativeResType;
+    writeHeaderValue(key: string): DeclarativeResType;
+    /**
+     * Write a chunk to the precompiled response
+     */
+    write(value: string): DeclarativeResType;
+    writeParameterValue(key: string): DeclarativeResType;
+    /**
+     * Method to finalize forming a response.
+     */
+    end(value: string): any;
+    writeBody(): DeclarativeResType;
+    /**
+     * additional method from µBlitz.js
+     */
+    writeHeaders<Opts extends BaseHeaders>(headers: Opts): DeclarativeResType;
+};
+/**
+ * Almost nothing different from uWS.DeclarativeResponse. The only modification - writeHeaders method (several methods, typescript intellisense)
+ */
+export declare var DeclarativeResponse: {
+    new (): DeclarativeResType;
+};
+export * from "./http-codes.js";
+export * from "./http-headers.js";

package/package.json

@@ -1,24 +1,47 @@
 {
   "name": "@ublitzjs/core",
-  "version": "0.1.1",
+  "version": "1.0.1",
+  "types": "./dist/types/index.d.ts",
+  "files": ["dist"],
+  "typesVersions": {
+    "*": {
+      ".": ["./dist/types/index.d.ts"]
+    }
+  },
   "exports": {
-    "types": "./types/index.d.ts",
-    "require": "./cjs/index.cjs",
-    "import": "./mjs/index.mjs"
+    "types": "./dist/types/index.d.ts",
+    "require": "./dist/cjs/index.js",
+    "import": "./dist/esm/index.js"
   },
   "dependencies": {
     "tseep": "^1.3.1",
-    "uWebSockets.js": "github:uNetworking/uWebSockets.js#v20.56.0"
+    "uWebSockets.js": "github:uNetworking/uWebSockets.js#v20.57.0"
   },
   "publishConfig": {
     "access": "public"
   },
   "devDependencies": {
-    "undici": "^7.16.0",
+    "@babel/cli": "^7.28.6",
+    "@babel/core": "^7.29.0",
+    "@babel/plugin-transform-modules-commonjs": "^7.28.6",
+    "@types/node": "^25.2.1",
+    "@types/ws": "^8.18.1",
     "esbuild": "^0.25.12",
+    "tsd": "^0.33.0",
     "vitest": "^4.0.8",
     "ws": "^8.18.3"
   },
+  "scripts": {
+    "trick-tsd": "bun link && bun link @ublitzjs/core",
+    "build:esm": "tsc -p tsconfig.esm.json && echo '{\"type\": \"module\"}' > dist/esm/package.json",
+    "build:cjs": "babel dist/esm --out-dir dist/cjs",
+    "build:types": "tsc -p tsconfig.types.json",
+    "build": "npm run build:types && npm run build:esm && npm run build:cjs",
+    "test": "tsd && vitest run"
+  },
+  "tsd": {
+    "directory": "tests"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/ublitzjs/core.git"
@@ -32,11 +55,14 @@
     "ublitzjs",
     "uWebSockets.js",
     "uws",
+    "typescript",
     "documentation",
     "http",
+    "websockets",
     "headers",
     "codes",
     "development",
-    "asynchronous code"
+    "asynchronous code",
+    "µBlitz.js"
   ]
 }

package/USAGE.md

@@ -1,319 +0,0 @@
-> some examples will be shown using typescript, all examples are esm (but can also be cjs)
-
-# Setup main file
-
-In this section each code sample will show more features, so be ready to see them one by one.
-
-## no routers or other imports
-
-### without package
-
-```typescript
-import uWS from "uWebSockets.js";
-
-const server = uWS.App();
-
-server.any("/*", (res, req) => {
-  // manually handle this
-  res.writeStatus("404").end("Nothing to see here!");
-});
-
-// though I don't use "run", it is needed for example
-function run() {
-  server.listen(9001, (token) =>
-    token ? console.info("Start success") : console.error("Start failure")
-  );
-}
-
-run();
-```
-
-### with core package (low deps)
-
-```typescript
-import uWS from "uWebSockets.js";
-
-// c404 is an ArrayBuffer (not all codes are converted, don't worry), toAB - conversion helper
-import { c404, toAB } from "@ublitzjs/core";
-
-const server = uWS.App();
-
-var noFoundMessage = toAB("Nothing to see here!");
-server.any("/*", (res, req) => {
-  res.writeStatus(c404).end(notFoundMessage);
-});
-
-function run() {
-  server.listen(9001, (token) =>
-    token ? console.info("Start success") : console.error("Start failure")
-  );
-}
-
-run();
-```
-
-### with core package (better version)
-
-```typescript
-import uWS from "uWebSockets.js";
-
-// extendApp - lets you use or write extensions, notFoundConstructor - send 404 with a message
-import { extendApp, notFoundConstructor } from "@ublitzjs/core";
-
-// all extensions will be typed in typescript, so server.run call is also typed.
-const server = extendApp(
-  uWS.App(),
-  /* your extensions as a rest parameter. They will be bound to "server" */ {
-    run(/*for typescript*/ this: Server) {
-      this.listen(9001, (token) =>
-        token ? console.info("Start success") : console.error("Start failure")
-      );
-    },
-  } /*, you can put here as many as you want. */
-);
-
-server.any("/*", notFoundConstructor("Nothing to see here!"));
-
-// use your extension
-server.run();
-```
-
-And last example, just to show real-world use-case for extendApp
-
-```typescript
-import uWS from "uWebSockets.js";
-import { extendApp, notFoundConstructor } from "@ublitzjs/core";
-
-import { serverExtension as openapiExt } from "@ublitzjs/openapi";
-
-const server = extendApp(
-  uWS.App(),
-  // this is very basic, so for better examples - go find source repo
-  openapiExt({
-    openapi: "3.0.0",
-    info: {
-      title: "Some ublitzjs server",
-      version: "0.0.1",
-    },
-  }),
-  // your extension can also be here
-  {
-    run(this: Server) {
-      this.listen(9001, (token) =>
-        token ? console.info("Start success") : console.error("Start failure")
-      );
-    },
-  }
-);
-// this function is given by the extension
-await server.serveOpenApi("/docs", { build: false, path: "openapi.json" });
-
-server.any("/*", notFoundConstructor("Nothing to see here!"));
-
-server.run();
-```
-
-So in extendApp you put "extensions", as I call them.
-
-## With routers (mainly not @ublitzjs/router) and other imports
-
-### two modules with core package
-
-_main.js_
-
-```typescript
-import uWS from "uWebSockets.js";
-import { extendApp } from "@ublitzjs/core";
-import router from "./router.js";
-const server = extendApp(uWS.App());
-// register "plugins", not "extensions"
-server.register(router);
-server.listen(9001, () => {});
-```
-
-here you have imported your router and registered it as a plugin. So "extension" gives you NEW functionality, while "plugin" should use your current functionality
-
-_router.js_
-
-```typescript
-import type { Server } from "@ublitzjs/core";
-// for readability and
-export default (server: Server) => {
-  server.get("/simple", (res) => {
-    res.end("hello");
-  });
-};
-```
-
-### example with @ublitzjs/router
-
-_main.js_ - the same. Nothing changed at all <br>
-_router.js_
-
-```typescript
-import type { Server } from "@ublitzjs/core";
-import { Router } from "@ublitzjs/router";
-// again - better explanations in source repo.
-// Generally, router looks like OpenAPI
-const router = new Router({
-  // route
-  "/simple": {
-    // method
-    get(res) {
-      res.end("hello");
-    },
-  },
-});
-export default (server: Server) => {
-  router.bind(server).define("/simple", "get");
-};
-```
-
-So here I showed you how to setup a main file and split your code into modules
-
-# Headers
-
-## HeadersMap
-
-This class is used to convert all headers to ArrayBuffers and quickly set them on each request.
-
-```typescript
-import { HeadersMap, definePlugin, toAB, type Server } from "@ublitzjs/core";
-// init headers
-const htmlHeaders = new HeadersMap({
-  "Content-Type": "text/html",
-});
-// convert strings to ArrayBuffers -> it returns a function
-const setHeaders = htmlHeaders.prepare();
-
-export default (server: Server) => {
-  const html = toAB("<h1>Hello</h1>");
-  server.get("/", (res) => {
-    // and this function returns "res" object
-    setHeaders(res).end(html);
-  });
-};
-```
-
-Also there is HeadersMap.default (see it in the code itself), HeadersMap.baseObj (also in the code), and HeadersMap.remove (you remove unwanted headers)
-
-## setCSP
-
-Creates a string of CSP, using array parameters.
-
-```typescript
-// in response (not recommended)
-res.writeHeader(
-  "Content-Security-Policy",
-  setCSP({ "default-src": ["'self'"] })
-);
-// in HeadersMap
-import { setCSP, HeadersMap, /*basic settings*/ CSPDirs } from "@ublitzjs";
-new HeadersMap({
-  "Content-Security-Policy": setCSP(
-    {
-      ...CSPDirs,
-      "connect-src": ["'self'", "https://example.com"],
-    },
-    /*remove directives in a rest param*/
-    "img-src",
-    "object-src"
-  ),
-}).prepare();
-```
-
-## lowHeaders
-
-Greatly fits when you need to use request.getHeader("sec-websocket-extensions"), but miss a letter or two. <br>
-See example below in "uWS types / DocumentedWS and DocumentedWSBehavior"
-
-# registerAbort
-
-this utility lets you extend your handlers in a very asynchronous manner and nothing will ever brake.<br>
-Emitter used here is "tseep", which is faster than node:events.
-
-```typescript
-import type { HttpResponse } from "@ublitzjs/core";
-function myOnAbort(res: HttpResponse) {
-  res.emitter.once("abort", () => {
-    /*do something*/
-  });
-}
-server.get("/", (res) => {
-  // use it
-  registerAbort(res);
-  console.log(/*added on the response*/ res.aborted, res.emitter);
-
-  res.emitter.once("abort", () => {
-    console.log("ABORTED");
-    // as an example
-    stopDatabaseTransaction();
-  });
-
-  myOnAbort();
-  /*here you something*/
-});
-```
-
-It is heavily used in @ublitzjs/req-body and @ublitzjs/static to stop file streams
-If you want a more interesting use-case, <a href="./examples/AsyncFunction.mts">Go here</a>
-
-# uWS types
-
-Another benefit of using this package are additional typescript docs for uWS, that they haven't added yet (I mean index.d.ts has no description yet).
-
-## DeclarativeResponse
-
-This class helps you define faster and more optimized controllers, because they are prebuilt before execution.<br>
-
-Instead of sending response dynamically each time with <code>res.end()</code> you generate the whole response with all headers and body right on the start of the application.<br>
-
-It is not something, that ublitzjs created (only <code>.writeHeaders</code> method), but rather just description it gives you with the class
-
-```typescript
-import { DeclarativeResponse } from "@ublitzjs";
-server.get(
-  "/fast-response",
-  new Declarative()
-    .writeHeader("Content-Type", "text/plain")
-    /*spec method*/ .writeHeaders({ Allow: "GET" })
-    .end("HI")
-);
-```
-
-## DocumentedWS and DocumentedWSBehavior
-
-These types add 3 methods to websocket object: sendFirstFragment, sendFragment, sendLastFragment.<br>
-More detailed description <a href="./types/uws-types.d.ts">here</a>
-
-```typescript
-import type { DocumentedWSBehavior, lowHeaders } from "@ublitzjs/core";
-import uWS from "uWebSockets.js";
-const server = uWS.App();
-server.ws("/*", {
-  upgrade(res, req, context) {
-    res.upgrade(
-      { url: req.getUrl() },
-      req.getHeader</*adds typescript support*/ lowHeaders>(
-        "sec-websocket-key"
-      ),
-      req.getHeader<lowHeaders>("sec-websocket-protocol"),
-      req.getHeader<lowHeaders>("sec-websocket-extensions"),
-      context
-    );
-  },
-  async open(ws) {
-    ws.sendFirstFragment("hello1\n");
-    ws.sendFragment("hello2\n");
-    ws.sendLastFragment("end hello");
-  },
-} as DocumentedWSBehavior<{}> as any);
-```
-
-# Bundling
-
-Best efficiency and start time can be achieved if the code is bundled and minified.<br>
-For this purpose you can use "esbuild" (at least it was tested and worked for both cjs and esm formats).<br>
-The only thing to remember: when you use it for bundling, don't forget to put "uWebSockets.js" to "external" array.<br>
-<a href="./examples/esbuild.mjs">Example 1</a><br>
-<a href="./tests/esbuild/build.mjs">Dynamic example 2</a>