@prismicio/next/dist/pages/exitPreview.d.cts

Helpers to integrate Prismic into Next.js apps

import { NextApiRequestLike, NextApiResponseLike } from "./types.cjs";

//#region src/pages/exitPreview.d.ts
/** Configuration for `exitPreview()`. */
type ExitPreviewAPIRouteConfig = {
  /**
   * The `req` object from a Next.js API route.
   *
   * @see Next.js API route docs: \<https://nextjs.org/docs/api-routes/introduction\>
   */
  req?: NextApiRequestLike;
  /**
   * The `res` object from a Next.js API route.
   *
   * @see Next.js API route docs: \<https://nextjs.org/docs/api-routes/introduction\>
   */
  res: NextApiResponseLike;
};
/**
 * Ends a Prismic preview session within a Next.js app. This function should be used in an API
 * route.
 *
 * @example
 * 	;```typescript
 * 	// src/pages/api/exit-preview.js
 *
 * 	import { exitPreview } from "@prismicio/next"
 *
 * 	export default function handler(_req, res) {
 * 		return exitPreview({ res })
 * 	}
 * 	```
 */
declare function exitPreview(config: ExitPreviewAPIRouteConfig): void;
//#endregion
export { ExitPreviewAPIRouteConfig, exitPreview };
//# sourceMappingURL=exitPreview.d.cts.map