Type alias NextApiResponse<Data>

Type declaration

• clearPreviewData: ((options?) => NextApiResponse<Data>)

  Clear preview data for Next.js' prerender mode

  • • (options?): NextApiResponse<Data>

    • Clear preview data for Next.js' prerender mode

      Parameters

      • Optional options: {
            path?: string;
        }

        • Optional path?: string

      Returns NextApiResponse<Data>

• json: Send<Data>

  Send data json data in response

• revalidate: ((urlPath, opts?) => Promise<void>)

  Revalidate a specific page and regenerate it using On-Demand Incremental Static Regeneration. The path should be an actual path, not a rewritten path. E.g. for "/blog/[slug]" this should be "/blog/post-1".

  Link

  https://nextjs.org/docs/basic-features/data-fetching/incremental-static-regeneration#on-demand-revalidation

  • • (urlPath, opts?): Promise<void>

    • Revalidate a specific page and regenerate it using On-Demand Incremental Static Regeneration. The path should be an actual path, not a rewritten path. E.g. for "/blog/[slug]" this should be "/blog/post-1".

      Parameters

      • urlPath: string

      • Optional opts: {
            unstable_onlyGenerated?: boolean;
        }

        • Optional unstable_onlyGenerated?: boolean

      Returns Promise<void>

      Link

      https://nextjs.org/docs/basic-features/data-fetching/incremental-static-regeneration#on-demand-revalidation

• send: Send<Data>

  Send data any data in response

• setDraftMode: ((options) => NextApiResponse<Data>)

  Set draft mode

  • • (options): NextApiResponse<Data>

    • Set draft mode

      Parameters

      • options: {
            enable: boolean;
        }

        • enable: boolean

      Returns NextApiResponse<Data>

• setPreviewData: ((data, options?) => NextApiResponse<Data>)

  Set preview data for Next.js' prerender mode

  • • (data, options?): NextApiResponse<Data>

    • Set preview data for Next.js' prerender mode

      Parameters

      • data: object | string

      • Optional options: {
            maxAge?: number;
            path?: string;
        }

        • Optional maxAge?: number

          Specifies the number (in seconds) for the preview session to last for. The given number will be converted to an integer by rounding down. By default, no maximum age is set and the preview session finishes when the client shuts down (browser is closed).

        • Optional path?: string

          Specifies the path for the preview session to work under. By default, the path is considered the "default path", i.e., any pages under "/".

      Returns NextApiResponse<Data>

• status: ((statusCode) => NextApiResponse<Data>)

  • • (statusCode): NextApiResponse<Data>

    • Parameters

      • statusCode: number

      Returns NextApiResponse<Data>

• redirect:function

  • redirect(url): NextApiResponse<Data>

  • Parameters

    • url: string

    Returns NextApiResponse<Data>

  • redirect(status, url): NextApiResponse<Data>

  • Parameters

    • status: number

    • url: string

    Returns NextApiResponse<Data>