@prismicio/next/dist/pages/enableAutoPreviews.d.ts

Helpers to integrate Prismic into Next.js apps

import { NextApiRequestLike } from "./types.js";
import { Client } from "@prismicio/client";
import { PreviewData } from "next";

//#region src/pages/enableAutoPreviews.d.ts
/**
 * Configuration for `enableAutoPreviews`.
 *
 * @typeParam TPreviewData - Next.js preview data object.
 */
type EnableAutoPreviewsConfig = {
  /** Prismic client with which automatic previews will be enabled. */client: Pick<Client, "queryContentFromRef" | "enableAutoPreviewsFromReq">;
  /**
   * The `previewData` object provided in the `getStaticProps()` or `getServerSideProps()` context
   * object.
   */
  previewData?: PreviewData;
  /**
   * The `req` object from a Next.js API route.
   *
   * @see Next.js API route docs: \<https://nextjs.org/docs/api-routes/introduction\>
   */
  req?: NextApiRequestLike;
};
/**
 * Configures a Prismic client to automatically query draft content during a preview session. It
 * either takes in a Next.js `getStaticProps` context object or a Next.js API endpoint request
 * object.
 *
 * @param config - Configuration for the function.
 */
declare function enableAutoPreviews(config: EnableAutoPreviewsConfig): void;
//#endregion
export { EnableAutoPreviewsConfig, enableAutoPreviews };
//# sourceMappingURL=enableAutoPreviews.d.ts.map