srvx 0.1.4 → 0.2.0

package/dist/types.d.ts

@@ -1,175 +0,0 @@
-import * as NodeHttp from 'node:http';
-import * as NodeNet from 'node:net';
-import * as BunTypes from 'bun';
-import BunTypes__default from 'bun';
-
-declare abstract class Server {
-    #private;
-    /**
-     * Current listening runtime name
-     */
-    abstract readonly runtime: "node" | "deno" | "bun";
-    /**
-     * Node.js listening server instance.
-     */
-    nodeServer?: NodeHttp.Server;
-    /**
-     * Bun listening server instance.
-     */
-    bunServer?: BunTypes__default.Server;
-    /**
-     * Deno listening server instance.
-     */
-    denoServer?: Deno.HttpServer;
-    /**
-     * Server options
-     */
-    options: Omit<ServerOptions, "fetch">;
-    /**
-     * Server fetch handler
-     */
-    fetch: ServerHandler;
-    constructor(options: ServerOptions);
-    protected abstract _listen(): void | Promise<void>;
-    /**
-     * Listening address (hostname or IP).
-     */
-    abstract readonly addr: string | null;
-    /**
-     * Listening port.
-     */
-    abstract readonly port: number | null;
-    /**
-     * Listening URL.
-     */
-    get url(): string | null;
-    /**
-     * Returns a promise that resolves when the server is ready.
-     */
-    ready(): Promise<Server>;
-    /**
-     * Stop listening to prevent new connections from being accepted.
-     *
-     * By default, it does not cancel in-flight requests or websockets. That means it may take some time before all network activity stops.
-     *
-     * @param closeActiveConnections Immediately terminate in-flight requests, websockets, and stop accepting new connections.
-     * @default false
-     */
-    abstract close(closeActiveConnections?: boolean): void | Promise<void>;
-}
-
-type MaybePromise<T> = T | Promise<T>;
-/**
- * Create a new server instance.
- */
-declare function serve(options: ServerOptions): Server;
-/**
- * Web fetch compatible request handler
- */
-type ServerHandler = (request: xRequest) => MaybePromise<Response>;
-/**
- * Server options
- */
-interface ServerOptions {
-    /**
-     * The fetch handler handles incoming requests.
-     */
-    fetch: ServerHandler;
-    /**
-     * Server plugins
-     */
-    plugins?: (ServerPlugin | ServerPluginInstance)[];
-    /**
-     * The port server should be listening to.
-     *
-     * Default is read from `PORT` environment variable or will be `3000`.
-     *
-     * **Tip:** You can set the port to `0` to use a random port.
-     */
-    port?: string | number;
-    /**
-     * The hostname (IP or resolvable host) server listener should bound to.
-     *
-     * When not provided, server with listen to all network interfaces by default.
-     *
-     * **Important:** If you are running a server that is not expected to be exposed to the network, use `hostname: "localhost"`.
-     */
-    hostname?: string;
-    /**
-     * Enabling this option allows multiple processes to bind to the same port, which is useful for load balancing.
-     *
-     * **Note:** Despite Node.js built-in behavior that has `exclusive` flag (opposite of `reusePort`) enabled by default, srvx uses non-exclusive mode for consistency.
-     */
-    reusePort?: boolean;
-    /**
-     * If this option is enabled, `request.xRemoteAddress` will be available.
-     *  **Example:**
-     *
-     *  ```js
-     *  serve({
-     *   port: 3000,
-     *    xRemoteAddress: true,
-     *    fetch: (request) =>
-     *      new Response(`Your ip address is ${request.xRemoteAddress}`),
-     *  });
-     * ```
-     * **Note:** In order to to provide cross-runtime consistency, a small wrapper function will be enabled for Deno and Bun runtimes if `xRemoteAddress` option is set.
-     */
-    xRemoteAddress?: boolean;
-    /**
-     * Node.js http server options.
-     */
-    node?: NodeHttp.ServerOptions & NodeNet.ListenOptions;
-    /**
-     * Bun server options
-     *
-     * @docs https://bun.sh/docs/api/http
-     */
-    bun?: Omit<BunTypes.ServeOptions, "fetch">;
-    /**
-     * Deno server options
-     *
-     * @docs https://docs.deno.com/api/deno/~/Deno.serve
-     */
-    deno?: Deno.ServeOptions;
-}
-type ServerPlugin = (server: Server) => MaybePromise<ServerPluginInstance>;
-interface ServerPluginInstance {
-    /**
-     * Plugin display name
-     */
-    name?: string;
-    /**
-     * Hook to allow running logic before user fetch handler
-     * If an response value is returned, user fetch handler and the next plugins will be skipped.
-     */
-    request?: (request: xRequest) => MaybePromise<Response | void>;
-    /**
-     * Hook to allow running logic after user fetch handler
-     * If a response value is returned, user response and the next plugins will be skipped.
-     */
-    response?: (request: xRequest, response: Response) => MaybePromise<void | Response>;
-}
-/**
- * https://developer.mozilla.org/en-US/docs/Web/API/Headers
- */
-type xHeaders = Omit<Headers, "count" | "toJSON" | "getAll">;
-/**
- * https://developer.mozilla.org/en-US/docs/Web/API/Request
- */
-interface xRequest extends Omit<Request, "headers" | "clone"> {
-    headers: xHeaders;
-    clone(): xRequest;
-    xNode?: {
-        req: NodeHttp.IncomingMessage;
-        res: NodeHttp.ServerResponse;
-    };
-    /**
-     * Remote address of the client.
-     */
-    xRemoteAddress?: string | null;
-    /** Optional user context */
-    xContext?: Record<string, unknown>;
-}
-
-export { Server, type ServerHandler, type ServerOptions, type ServerPlugin, type ServerPluginInstance, serve, type xHeaders, type xRequest };

package/dist/types.mjs

@@ -1 +0,0 @@
-