@stacksjs/bun-router 0.1.15 → 0.1.17

package/dist/response/compression.d.ts

@@ -100,10 +100,23 @@ export declare function compressResponse(response: Response, request: Request, o
  * the prefix, which is what makes a small answer distinguishable from the
  * beginning of a large one.
  */
-export declare function peekBody(source: ReadableStream<Uint8Array>, limit: number): Promise<{
-    stream: ReadableStream<Uint8Array>;
+export interface PeekedBody {
+    /**
+     * What to send.
+     *
+     * Bytes when the body ended inside the prefix, a stream when it did not.
+     * The distinction is the whole point: a body that ended was never a stream,
+     * it was a small answer that arrived whole, and rebuilding it as a stream
+     * asks Bun for a controller, a start microtask and a drain per response.
+     * Measured on a route returning seventeen bytes of JSON, that machinery was
+     * roughly three times the cost of answering the request.
+     */
+    body: ReadableStream<Uint8Array> | Uint8Array;
     size: number;
     ended: boolean;
-}>;
+}
+/** A stream again, for the branch that has to pipe what it peeked. */
+export declare function peekedStream(peeked: PeekedBody): ReadableStream<Uint8Array>;
+export declare function peekBody(source: ReadableStream<Uint8Array>, limit: number): Promise<PeekedBody>;
 /** Add to `Vary` without dropping what is already there. */
 export declare function appendVary(headers: Headers, value: string): void;

package/dist/types.d.ts

@@ -832,7 +832,18 @@ export interface UploadedFile {
     mimetype: string;
     buffer: ArrayBuffer;
 }
-export type RouteHandler = (_req: EnhancedRequest) => Response | Promise<Response>;
+/**
+ * What a handler may return.
+ *
+ * The resolver has always wrapped a plain value - `wrapResponse` turns a
+ * string, a number, a boolean, bytes, a stream, or an object into a Response,
+ * and the handler-resolver documents that as a supported shape. The types said
+ * otherwise, so the documented idiom did not compile and every example that
+ * returns an object had to be cast. Widening this is safe for existing
+ * handlers: a `Response` is still a `RouteResult`.
+ */
+export type RouteResult = Response | string | number | boolean | ArrayBuffer | Uint8Array | ReadableStream | object | null | undefined;
+export type RouteHandler = (_req: EnhancedRequest) => RouteResult | Promise<RouteResult>;
 /**
  * Interface for handling route actions.
  * All action handlers must implement this interface.
@@ -1226,7 +1237,7 @@ export type RequestFor<TPath extends string> = Omit<EnhancedRequest, 'params'> &
     params: ExtractRouteParams<TPath>;
 };
 export interface TypedRouteHandler<TPath extends string> {
-    (req: RequestFor<TPath>): Response | Promise<Response>;
+    (req: RequestFor<TPath>): RouteResult | Promise<RouteResult>;
 }
 /**
  * Strongly typed route definition for specific HTTP methods

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/bun-router",
   "type": "module",
-  "version": "0.1.15",
+  "version": "0.1.17",
   "description": "A fast, type-safe router for Bun.",
   "author": "Chris Breuer <chris@stacksjs.com>",
   "license": "MIT",