bun-types 0.8.0 → 0.8.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bun-types",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "description": "Type definitions for Bun, an incredibly fast JavaScript runtime",
   "types": "types.d.ts",
   "files": [

package/tsconfig.json

@@ -13,7 +13,7 @@
     "skipLibCheck": true,
     "jsx": "react-jsx",
     "allowImportingTsExtensions": true,
-    "emitDeclarationOnly": true,
+    "noEmit": true,
     "composite": true,
     "allowSyntheticDefaultImports": true,
     "forceConsistentCasingInFileNames": true,

package/types.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for bun 0.8.0
+// Type definitions for bun 0.8.1
 // Project: https://github.com/oven-sh/bun
 // Definitions by: Jarred Sumner <https://github.com/Jarred-Sumner>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -5051,7 +5051,7 @@ interface BlobInterface {
 type BlobPart = string | Blob | BufferSource;
 interface BlobPropertyBag {
   /** Set a default "type". Not yet implemented. */
-  // type?: string;
+  type?: string;
   /** Not implemented in Bun yet. */
   // endings?: "transparent" | "native";
 }
@@ -9061,8 +9061,12 @@ declare module "bun" {
   export type Serve<WebSocketDataType = undefined> =
     | ServeOptions
     | TLSServeOptions
+    | UnixServeOptions
+    | UnixTLSServeOptions
     | WebSocketServeOptions<WebSocketDataType>
-    | TLSWebSocketServeOptions<WebSocketDataType>;
+    | TLSWebSocketServeOptions<WebSocketDataType>
+    | UnixWebSocketServeOptions<WebSocketDataType>
+    | UnixTLSWebSocketServeOptions<WebSocketDataType>;
 
   /**
    * Start a fast HTTP server.
@@ -9100,13 +9104,7 @@ declare module "bun" {
    * });
    * ```
    */
-  export function serve<T>(
-    options:
-      | ServeOptions
-      | TLSServeOptions
-      | WebSocketServeOptions<T>
-      | TLSWebSocketServeOptions<T>,
-  ): Server;
+  export function serve<T>(options: Serve<T>): Server;
 
   /**
    * Synchronously resolve a `moduleId` as though it were imported from `parent`
@@ -10772,32 +10770,7 @@ declare module "bun" {
 
   interface GenericServeOptions {
     /**
-     * What port should the server listen on?
-     * @default process.env.PORT || "3000"
-     */
-    port?: string | number;
-
-    /**
-     * What hostname should the server listen on?
-     *
-     * @default
-     * ```js
-     * "0.0.0.0" // listen on all interfaces
-     * ```
-     * @example
-     *  ```js
-     * "127.0.0.1" // Only listen locally
-     * ```
-     * @example
-     * ```js
-     * "remix.run" // Only listen on remix.run
-     * ````
      *
-     * note: hostname should not include a {@link port}
-     */
-    hostname?: string;
-
-    /**
      * What URI should be used to make {@link Request.url} absolute?
      *
      * By default, looks at {@link hostname}, {@link port}, and whether or not SSL is enabled to generate one
@@ -10816,7 +10789,6 @@ declare module "bun" {
      *
      * @example
      * "http://localhost:3000"
-     *
      */
     // baseURI?: string;
 
@@ -10840,6 +10812,38 @@ declare module "bun" {
 
   export type AnyFunction = (..._: any[]) => any;
   export interface ServeOptions extends GenericServeOptions {
+    /**
+     * What port should the server listen on?
+     * @default process.env.PORT || "3000"
+     */
+    port?: string | number;
+
+    /**
+     * What hostname should the server listen on?
+     *
+     * @default
+     * ```js
+     * "0.0.0.0" // listen on all interfaces
+     * ```
+     * @example
+     *  ```js
+     * "127.0.0.1" // Only listen locally
+     * ```
+     * @example
+     * ```js
+     * "remix.run" // Only listen on remix.run
+     * ````
+     *
+     * note: hostname should not include a {@link port}
+     */
+    hostname?: string;
+
+    /**
+     * If set, the HTTP server will listen on a unix socket instead of a port.
+     * (Cannot be used with hostname+port)
+     */
+    unix?: never;
+
     /**
      * Handle HTTP requests
      *
@@ -10853,8 +10857,113 @@ declare module "bun" {
     ): Response | Promise<Response>;
   }
 
+  export interface UnixServeOptions extends GenericServeOptions {
+    /**
+     * If set, the HTTP server will listen on a unix socket instead of a port.
+     * (Cannot be used with hostname+port)
+     */
+    unix: string;
+    /**
+     * Handle HTTP requests
+     *
+     * Respond to {@link Request} objects with a {@link Response} object.
+     */
+    fetch(
+      this: Server,
+      request: Request,
+      server: Server,
+    ): Response | Promise<Response>;
+  }
+
   export interface WebSocketServeOptions<WebSocketDataType = undefined>
     extends GenericServeOptions {
+    /**
+     * What port should the server listen on?
+     * @default process.env.PORT || "3000"
+     */
+    port?: string | number;
+
+    /**
+     * What hostname should the server listen on?
+     *
+     * @default
+     * ```js
+     * "0.0.0.0" // listen on all interfaces
+     * ```
+     * @example
+     *  ```js
+     * "127.0.0.1" // Only listen locally
+     * ```
+     * @example
+     * ```js
+     * "remix.run" // Only listen on remix.run
+     * ````
+     *
+     * note: hostname should not include a {@link port}
+     */
+    hostname?: string;
+
+    /**
+     * Enable websockets with {@link Bun.serve}
+     *
+     * For simpler type safety, see {@link Bun.websocket}
+     *
+     * @example
+     * ```js
+     *import { serve } from "bun";
+     *serve({
+     *  websocket: {
+     *    open: (ws) => {
+     *      console.log("Client connected");
+     *    },
+     *    message: (ws, message) => {
+     *      console.log("Client sent message", message);
+     *    },
+     *    close: (ws) => {
+     *      console.log("Client disconnected");
+     *    },
+     *  },
+     *  fetch(req, server) {
+     *    const url = new URL(req.url);
+     *    if (url.pathname === "/chat") {
+     *      const upgraded = server.upgrade(req);
+     *      if (!upgraded) {
+     *        return new Response("Upgrade failed", { status: 400 });
+     *      }
+     *    }
+     *    return new Response("Hello World");
+     *  },
+     *});
+     *```
+     * Upgrade a {@link Request} to a {@link ServerWebSocket} via {@link Server.upgrade}
+     *
+     * Pass `data` in @{link Server.upgrade} to attach data to the {@link ServerWebSocket.data} property
+     *
+     *
+     */
+    websocket: WebSocketHandler<WebSocketDataType>;
+
+    /**
+     * Handle HTTP requests or upgrade them to a {@link ServerWebSocket}
+     *
+     * Respond to {@link Request} objects with a {@link Response} object.
+     *
+     */
+    fetch(
+      this: Server,
+      request: Request,
+      server: Server,
+    ): Response | undefined | Promise<Response | undefined>;
+  }
+
+  export interface UnixWebSocketServeOptions<WebSocketDataType = undefined>
+    extends GenericServeOptions {
+    /**
+     * If set, the HTTP server will listen on a unix socket instead of a port.
+     * (Cannot be used with hostname+port)
+     */
+    unix: string;
+
     /**
      * Enable websockets with {@link Bun.serve}
      *
@@ -10911,6 +11020,17 @@ declare module "bun" {
   export interface TLSWebSocketServeOptions<WebSocketDataType = undefined>
     extends WebSocketServeOptions<WebSocketDataType>,
       TLSOptions {
+    unix?: never;
+    tls?: TLSOptions;
+  }
+  export interface UnixTLSWebSocketServeOptions<WebSocketDataType = undefined>
+    extends UnixWebSocketServeOptions<WebSocketDataType>,
+      TLSOptions {
+    /**
+     * If set, the HTTP server will listen on a unix socket instead of a port.
+     * (Cannot be used with hostname+port)
+     */
+    unix: string;
     tls?: TLSOptions;
   }
   export interface Errorlike extends Error {
@@ -11027,6 +11147,16 @@ declare module "bun" {
     tls?: TLSOptions;
   }
 
+  export interface UnixTLSServeOptions extends UnixServeOptions, TLSOptions {
+    /**
+     *  The keys are [SNI](https://en.wikipedia.org/wiki/Server_Name_Indication) hostnames.
+     *  The values are SSL options objects.
+     */
+    serverNames?: Record<string, TLSOptions>;
+
+    tls?: TLSOptions;
+  }
+
   /**
    * HTTP & HTTPS Server
    *
@@ -11037,7 +11167,6 @@ declare module "bun" {
    * avoid starting and stopping the server often (unless it's a new instance of bun).
    *
    * Powered by a fork of [uWebSockets](https://github.com/uNetworking/uWebSockets). Thank you @alexhultman.
-   *
    */
   export interface Server {
     /**