Function: previewHandler()

previewHandler(req, res, options): Promise<void>

Defined in: packages/next/src/handlers/previewHandler.ts:125

The PreviewHandler is responsible for handling preview requests.

Handling Previews requires the Headless WordPress Plugin.

Important: This function is meant to be used in a api route at /pages/api/preview.

Usage

// pages/api/preview.js
import { previewHandler } from '@headstartwp/next';

export default async function handler(req, res) {
	return previewHandler(req, res);
}

Parameters

req

NextApiRequest

The request object,

res

NextApiResponse

The response object.

options

PreviewHandlerOptions = {}

The PreviewHandlerOptions PreviewHandlerOptions

Returns

Promise<void>

A response object.