Options
All
  • Public
  • Public/Protected
  • All
Menu

Module next-server/server/router

Index

Classes

Type aliases

Functions

Type aliases

DynamicRoutes

DynamicRoutes: { match: RouteMatch; page: string }[]

PageChecker

PageChecker: (pathname: string) => Promise<boolean>

Type declaration

    • (pathname: string): Promise<boolean>

    • Parameters

      • pathname: string

      Returns Promise<boolean>

Params

Params: {}

Type declaration

  • [param: string]: any

Route

Route: { check?: boolean; fn: (req: IncomingMessage, res: ServerResponse, params: Params, parsedUrl: UrlWithParsedQuery) => Promise<RouteResult> | RouteResult; internal?: true; match: RouteMatch; name: string; requireBasePath?: false; statusCode?: number; type: string }

Type declaration

  • Optional check?: boolean
  • fn: (req: IncomingMessage, res: ServerResponse, params: Params, parsedUrl: UrlWithParsedQuery) => Promise<RouteResult> | RouteResult
      • (req: IncomingMessage, res: ServerResponse, params: Params, parsedUrl: UrlWithParsedQuery): Promise<RouteResult> | RouteResult

      • Parameters

        • req: IncomingMessage
        • res: ServerResponse
        • params: Params
        • parsedUrl: UrlWithParsedQuery

        Returns Promise<RouteResult> | RouteResult

  • Optional internal?: true
  • match: RouteMatch
  • name: string
  • Optional requireBasePath?: false
  • Optional statusCode?: number
  • type: string

RouteMatch

RouteMatch: (pathname: string | null | undefined) => false | Params

Type declaration

    • (pathname: string | null | undefined): false | Params

    • Parameters

      • pathname: string | null | undefined

      Returns false | Params

Functions

Const route

  • route(path: string): (pathname: undefined | null | string, params?: any) => any

  • Parameters

    • path: string

    Returns (pathname: undefined | null | string, params?: any) => any

      • (pathname: undefined | null | string, params?: any): any

      • Parameters

        • pathname: undefined | null | string
        • Optional params: any

        Returns any

Generated using TypeDoc