Module next-server/server/api-utils

Index

Classes

ApiError

Type aliases

Variables

SYMBOL_PREVIEW_DATA

Functions

Type aliases

NextApiRequestCookies

NextApiRequestCookies: {}

Type declaration

[key: string]: string

NextApiRequestQuery

NextApiRequestQuery: {}

Type declaration

[key: string]: string | string[]

__ApiPreviewProps

__ApiPreviewProps: { previewModeEncryptionKey: string; previewModeId: string; previewModeSigningKey: string }

Type declaration

previewModeEncryptionKey: string
previewModeId: string
previewModeSigningKey: string

Variables

Const SYMBOL_PREVIEW_DATA

SYMBOL_PREVIEW_DATA: unique symbol

Functions

apiResolver

apiResolver(req: IncomingMessage, res: ServerResponse, query: any, resolverModule: any, apiContext: __ApiPreviewProps, propagateError: boolean, onError?: ({ err }: { err: any }) => Promise<void>): Promise<void>

- Defined in packages/next/dist/next-server/server/api-utils.d.ts:16
Parameters
- req: IncomingMessage
- res: ServerResponse
- query: any
- resolverModule: any
- apiContext: __ApiPreviewProps
- propagateError: boolean
- Optional onError: ({ err }: { err: any }) => Promise<void>
  - - ({ err }: { err: any }): Promise<void>
    - Parameters
      - { err }: { err: any }
        
        err: any
      Returns Promise<void>
Returns Promise<void>

getCookieParser

getCookieParser(req: IncomingMessage): () => NextApiRequestCookies

- Defined in packages/next/dist/next-server/server/api-utils.d.ts:28
Parse cookies from req header

Parameters
- req: IncomingMessage
  
  request object
Returns () => NextApiRequestCookies
- - (): NextApiRequestCookies
  - Returns NextApiRequestCookies

parseBody

parseBody(req: NextApiRequest, limit: string | number): Promise<any>

- Defined in packages/next/dist/next-server/server/api-utils.d.ts:23
Parse incoming message like json or urlencoded

Parameters
- req: NextApiRequest
  
  request object
- limit: string | number
Returns Promise<any>

redirect

redirect(res: NextApiResponse, statusOrUrl: string | number, url?: string): NextApiResponse<any>

- Defined in packages/next/dist/next-server/server/api-utils.d.ts:41
Parameters
- res: NextApiResponse
  
  response object
- statusOrUrl: string | number
- Optional url: string
  
  URL of redirect
Returns NextApiResponse<any>

sendData

sendData(req: NextApiRequest, res: NextApiResponse, body: any): void

- Defined in packages/next/dist/next-server/server/api-utils.d.ts:48
Send any body to response

Parameters
- req: NextApiRequest
  
  request object
- res: NextApiResponse
  
  response object
- body: any
  
  of response
Returns void

sendError

sendError(res: NextApiResponse, statusCode: number, message: string): void

- Defined in packages/next/dist/next-server/server/api-utils.d.ts:70
Sends error in response

Parameters
- res: NextApiResponse
  
  response object
- statusCode: number
  
  of response
- message: string
  
  of response
Returns void

sendJson

sendJson(res: NextApiResponse, jsonBody: any): void

- Defined in packages/next/dist/next-server/server/api-utils.d.ts:54
Send JSON object

Parameters
- res: NextApiResponse
  
  response object
- jsonBody: any
  
  of data
Returns void

sendStatusCode

sendStatusCode(res: NextApiResponse, statusCode: number): NextApiResponse<any>

- Defined in packages/next/dist/next-server/server/api-utils.d.ts:34
Parameters
- res: NextApiResponse
  
  response object
- statusCode: number
  
  HTTP status code of response
Returns NextApiResponse<any>

setLazyProp

setLazyProp<T>(__namedParameters: LazyProps, prop: string, getter: () => T): void

- Defined in packages/next/dist/next-server/server/api-utils.d.ts:81
Execute getter function only if its needed

Type parameters
- T
Parameters
- __namedParameters: LazyProps
- prop: string
  
  name of property
- getter: () => T
  
  function to get data
  - - (): T
    - Returns T
Returns void

tryGetPreviewData

tryGetPreviewData(req: IncomingMessage, res: ServerResponse, options: __ApiPreviewProps): object | string | false

- Defined in packages/next/dist/next-server/server/api-utils.d.ts:56
Parameters
- req: IncomingMessage
- res: ServerResponse
- options: __ApiPreviewProps
Returns object | string | false

Generated using TypeDoc