@qwik.dev/router 2.0.0-beta.10 → 2.0.0-beta.13

package/lib/middleware/request-handler/index.d.ts

@@ -1,10 +1,12 @@
 import type { Action } from '@qwik.dev/router';
+import type { AsyncLocalStorage } from 'node:async_hooks';
 import type { EnvGetter as EnvGetter_2 } from '@qwik.dev/router/middleware/request-handler';
 import type { FailReturn } from '@qwik.dev/router';
 import type { Loader as Loader_2 } from '@qwik.dev/router';
 import type { QwikCityPlan } from '@qwik.dev/router';
 import type { QwikIntrinsicElements } from '@qwik.dev/core';
 import type { QwikRouterConfig } from '@qwik.dev/router';
+import { RedirectMessage as RedirectMessage_2 } from '@qwik.dev/router/middleware/request-handler';
 import type { Render } from '@qwik.dev/core/server';
 import type { RenderOptions } from '@qwik.dev/core/server';
 import { RequestEvent as RequestEvent_2 } from '@qwik.dev/router/middleware/request-handler';
@@ -17,6 +19,9 @@ import type { ValueOrPromise } from '@qwik.dev/core';
 export declare class AbortMessage {
 }
 
+/** @internal */
+export declare let _asyncRequestStore: AsyncLocalStorage<RequestEventInternal> | undefined;
+
 /** @public */
 export declare type CacheControl = CacheControlOptions | number | 'day' | 'week' | 'month' | 'year' | 'no-cache' | 'immutable' | 'private';
 
@@ -204,6 +209,7 @@ declare type DocumentHead = DocumentHeadValue | ((props: DocumentHeadProps) => D
 /** @public */
 declare interface DocumentHeadProps extends RouteLocation {
     readonly head: ResolvedDocumentHead;
+    /** @deprecated This is not necessary, it works correctly without */
     readonly withLocale: <T>(fn: () => T) => T;
     readonly resolveValue: ResolveSyncValue_2;
 }
@@ -330,9 +336,21 @@ declare interface PageModule extends RouteModule {
 declare type PathParams = Record<string, string>;
 
 declare interface QwikRouterRun<T> {
+    /**
+     * The response to the request, if any. If there is no response, there might have been an error,
+     * or the request was aborted.
+     */
     response: Promise<T | null>;
     requestEv: RequestEvent_2;
-    completion: Promise<unknown>;
+    /**
+     * Promise for the completion of the request.
+     *
+     * If it returns a RedirectMessage, it means the request must be redirected.
+     *
+     * If it returns an Error, it means there was an error, and if possible, the response already
+     * includes the error. The error is informational only.
+     */
+    completion: Promise<RedirectMessage_2 | Error | undefined>;
 }
 
 /**
@@ -570,7 +588,7 @@ export declare const RequestEvShareQData = "qData";
 export declare type RequestHandler<PLATFORM = QwikRouterPlatform> = (ev: RequestEvent<PLATFORM>) => Promise<void> | void;
 
 /**
- * The request handler for QwikRouter. Called by every integration.
+ * The request handler for QwikRouter. Called by every adapter.
  *
  * @public
  */