@upstash/qstash 2.10.0 → 2.11.0

package/nextjs.d.ts

@@ -1,6 +1,6 @@
 import { NextApiHandler } from 'next';
 import { NextRequest, NextFetchEvent } from 'next/server';
-import { ae as RouteFunction, af as WorkflowServeOptions } from './client-CsM1dTnz.js';
+import { ae as RouteFunction, af as WorkflowServeOptions } from './client-CUioGZfg.js';
 import 'neverthrow';
 
 type VerifySignatureConfig = {
@@ -18,6 +18,17 @@ type VerifySignatureConfig = {
      * @default 0
      */
     clockTolerance?: number;
+    /**
+     * Use the local dev server signing keys. Pair this with
+     * `new Client({ devMode: true })` for end-to-end local development.
+     *
+     * - `true`: use dev server signing keys
+     * - `false`: never use dev server signing keys (ignores QSTASH_DEV env var)
+     * - `undefined`: check QSTASH_DEV env var
+     *
+     * @default undefined
+     */
+    devMode?: boolean;
 };
 declare function verifySignature(handler: NextApiHandler, config?: VerifySignatureConfig): NextApiHandler;
 declare function verifySignatureEdge(handler: (request: NextRequest, nfe?: NextFetchEvent) => Response | Promise<Response>, config?: VerifySignatureConfig): (request: NextRequest, nfe: NextFetchEvent) => Promise<Response>;
@@ -43,5 +54,25 @@ declare const serve: <TInitialPayload = unknown>(routeFunction: RouteFunction<TI
  * Migration Guide: https://upstash.com/docs/workflow/migration
  */
 declare const servePagesRouter: <TInitialPayload = unknown>(routeFunction: RouteFunction<TInitialPayload>, options?: Omit<WorkflowServeOptions<Response, TInitialPayload>, "onStepFinish">) => NextApiHandler;
+/**
+ * Start the QStash dev server early during Next.js initialization.
+ *
+ * Call this inside your `instrumentation.ts` `register()` function so
+ * the dev server is ready before any request — including edge routes
+ * that cannot start it themselves.
+ *
+ * No-op in production, during `next build`, or in edge runtime.
+ *
+ * @example
+ * ```ts
+ * // instrumentation.ts
+ * import { registerQStashDev } from "@upstash/qstash/nextjs";
+ *
+ * export function register() {
+ *   registerQStashDev();
+ * }
+ * ```
+ */
+declare function registerQStashDev(): Promise<void>;
 
-export { type VerifySignatureConfig, serve, servePagesRouter, verifySignature, verifySignatureAppRouter, verifySignatureEdge };
+export { type VerifySignatureConfig, registerQStashDev, serve, servePagesRouter, verifySignature, verifySignatureAppRouter, verifySignatureEdge };