Options
All
  • Public
  • Public/Protected
  • All
Menu

Module build/webpack/loaders/next-serverless-loader/utils

Index

Type aliases

Variables

Functions

Type aliases

ServerlessHandlerCtx

ServerlessHandlerCtx: { appModule?: any; assetPrefix: string; basePath: string; buildId: string; buildManifest?: BuildManifest; canonicalBase: string; distDir: string; documentModule?: any; encodedPreviewProps: __ApiPreviewProps; errorModule?: any; escapedBuildId: string; experimental: { initServer: () => Promise<any>; onError: ({ err }: { err: Error }) => Promise<any> }; generateEtags: boolean; i18n?: NextConfig["i18n"]; notFoundModule?: any; page: string; pageComponent?: any; pageConfig?: any; pageGetServerSideProps?: GetServerSideProps; pageGetStaticPaths?: GetStaticPaths; pageGetStaticProps?: GetStaticProps; pageIsDynamic: boolean; pageModule: any; poweredByHeader: boolean; reactLoadableManifest?: any; rewrites: Rewrite[]; runtimeConfig: any }

Type declaration

  • Optional appModule?: any
  • assetPrefix: string
  • basePath: string
  • buildId: string
  • Optional buildManifest?: BuildManifest
  • canonicalBase: string
  • distDir: string
  • Optional documentModule?: any
  • encodedPreviewProps: __ApiPreviewProps
  • Optional errorModule?: any
  • escapedBuildId: string
  • experimental: { initServer: () => Promise<any>; onError: ({ err }: { err: Error }) => Promise<any> }
    • initServer: () => Promise<any>
        • (): Promise<any>

        • Returns Promise<any>

    • onError: ({ err }: { err: Error }) => Promise<any>
        • ({ err }: { err: Error }): Promise<any>

        • Parameters

          • { err }: { err: Error }
            • err: Error

          Returns Promise<any>

  • generateEtags: boolean
  • Optional i18n?: NextConfig["i18n"]
  • Optional notFoundModule?: any
  • page: string
  • Optional pageComponent?: any
  • Optional pageConfig?: any
  • Optional pageGetServerSideProps?: GetServerSideProps
  • Optional pageGetStaticPaths?: GetStaticPaths
  • Optional pageGetStaticProps?: GetStaticProps
  • pageIsDynamic: boolean
  • pageModule: any
  • poweredByHeader: boolean
  • Optional reactLoadableManifest?: any
  • rewrites: Rewrite[]
  • runtimeConfig: any

Variables

Const vercelHeader

vercelHeader: "x-vercel-id" = "x-vercel-id"

Functions

getUtils

  • getUtils(__namedParameters: { basePath: ServerlessHandlerCtx["basePath"]; i18n?: ServerlessHandlerCtx["i18n"]; page: ServerlessHandlerCtx["page"]; pageIsDynamic: ServerlessHandlerCtx["pageIsDynamic"]; rewrites: ServerlessHandlerCtx["rewrites"] }): { defaultRouteMatches: ParsedUrlQuery | undefined; defaultRouteRegex: { groups: {}; namedRegex?: string; re: RegExp; routeKeys?: {} } | undefined; dynamicRouteMatcher: ((pathname: string | null | undefined) => false | {}) | undefined; getParamsFromRouteMatches: (req: IncomingMessage, renderOpts?: any, detectedLocale?: string) => ParsedUrlQuery; handleBasePath: (req: IncomingMessage, parsedUrl: UrlWithParsedQuery) => void; handleLocale: (req: IncomingMessage, res: ServerResponse, parsedUrl: UrlWithParsedQuery, routeNoAssetPath: string, shouldNotRedirect: boolean) => { defaultLocale: string; detectedLocale: string; routeNoAssetPath: string } | undefined; handleRewrites: (parsedUrl: UrlWithParsedQuery) => UrlWithParsedQuery; interpolateDynamicPath: (pathname: string, params: ParsedUrlQuery) => string; normalizeDynamicRouteParams: (params: ParsedUrlQuery) => { hasValidParams: boolean; params: ParsedUrlQuery }; normalizeVercelUrl: (req: IncomingMessage, trustQuery: boolean) => void }

  • Parameters

    Returns { defaultRouteMatches: ParsedUrlQuery | undefined; defaultRouteRegex: { groups: {}; namedRegex?: string; re: RegExp; routeKeys?: {} } | undefined; dynamicRouteMatcher: ((pathname: string | null | undefined) => false | {}) | undefined; getParamsFromRouteMatches: (req: IncomingMessage, renderOpts?: any, detectedLocale?: string) => ParsedUrlQuery; handleBasePath: (req: IncomingMessage, parsedUrl: UrlWithParsedQuery) => void; handleLocale: (req: IncomingMessage, res: ServerResponse, parsedUrl: UrlWithParsedQuery, routeNoAssetPath: string, shouldNotRedirect: boolean) => { defaultLocale: string; detectedLocale: string; routeNoAssetPath: string } | undefined; handleRewrites: (parsedUrl: UrlWithParsedQuery) => UrlWithParsedQuery; interpolateDynamicPath: (pathname: string, params: ParsedUrlQuery) => string; normalizeDynamicRouteParams: (params: ParsedUrlQuery) => { hasValidParams: boolean; params: ParsedUrlQuery }; normalizeVercelUrl: (req: IncomingMessage, trustQuery: boolean) => void }

    • defaultRouteMatches: ParsedUrlQuery | undefined
    • defaultRouteRegex: { groups: {}; namedRegex?: string; re: RegExp; routeKeys?: {} } | undefined
    • dynamicRouteMatcher: ((pathname: string | null | undefined) => false | {}) | undefined
    • getParamsFromRouteMatches: (req: IncomingMessage, renderOpts?: any, detectedLocale?: string) => ParsedUrlQuery
        • (req: IncomingMessage, renderOpts?: any, detectedLocale?: string): ParsedUrlQuery

        • Parameters

          • req: IncomingMessage
          • Optional renderOpts: any
          • Optional detectedLocale: string

          Returns ParsedUrlQuery

    • handleBasePath: (req: IncomingMessage, parsedUrl: UrlWithParsedQuery) => void
        • (req: IncomingMessage, parsedUrl: UrlWithParsedQuery): void

        • Parameters

          • req: IncomingMessage
          • parsedUrl: UrlWithParsedQuery

          Returns void

    • handleLocale: (req: IncomingMessage, res: ServerResponse, parsedUrl: UrlWithParsedQuery, routeNoAssetPath: string, shouldNotRedirect: boolean) => { defaultLocale: string; detectedLocale: string; routeNoAssetPath: string } | undefined
        • (req: IncomingMessage, res: ServerResponse, parsedUrl: UrlWithParsedQuery, routeNoAssetPath: string, shouldNotRedirect: boolean): { defaultLocale: string; detectedLocale: string; routeNoAssetPath: string } | undefined

        • Parameters

          • req: IncomingMessage
          • res: ServerResponse
          • parsedUrl: UrlWithParsedQuery
          • routeNoAssetPath: string
          • shouldNotRedirect: boolean

          Returns { defaultLocale: string; detectedLocale: string; routeNoAssetPath: string } | undefined

    • handleRewrites: (parsedUrl: UrlWithParsedQuery) => UrlWithParsedQuery
        • (parsedUrl: UrlWithParsedQuery): UrlWithParsedQuery

        • Parameters

          • parsedUrl: UrlWithParsedQuery

          Returns UrlWithParsedQuery

    • interpolateDynamicPath: (pathname: string, params: ParsedUrlQuery) => string
        • (pathname: string, params: ParsedUrlQuery): string

        • Parameters

          • pathname: string
          • params: ParsedUrlQuery

          Returns string

    • normalizeDynamicRouteParams: (params: ParsedUrlQuery) => { hasValidParams: boolean; params: ParsedUrlQuery }
        • (params: ParsedUrlQuery): { hasValidParams: boolean; params: ParsedUrlQuery }

        • Parameters

          • params: ParsedUrlQuery

          Returns { hasValidParams: boolean; params: ParsedUrlQuery }

          • hasValidParams: boolean
          • params: ParsedUrlQuery
    • normalizeVercelUrl: (req: IncomingMessage, trustQuery: boolean) => void
        • (req: IncomingMessage, trustQuery: boolean): void

        • Parameters

          • req: IncomingMessage
          • trustQuery: boolean

          Returns void

Generated using TypeDoc