Options
All
  • Public
  • Public/Protected
  • All
Menu

Module next-server/lib/utils

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

AppContextType

AppContextType<R>: { AppTree: AppTreeType; Component: NextComponentType<NextPageContext>; ctx: NextPageContext; router: R }

Type parameters

Type declaration

AppInitialProps

AppInitialProps: { pageProps: any }

Type declaration

  • pageProps: any

AppPropsType

AppPropsType<R, P>: AppInitialProps & { Component: NextComponentType<NextPageContext, any, P>; __N_SSG?: boolean; __N_SSP?: boolean; router: R }

Type parameters

AppTreeType

AppTreeType: ComponentType<AppInitialProps & {}>

AppType

AppType: NextComponentType<AppContextType, AppInitialProps, AppPropsType>

BaseContext

BaseContext: { res?: ServerResponse }

Type declaration

  • [k: string]: any
  • Optional res?: ServerResponse

ComponentsEnhancer

ComponentsEnhancer: { enhanceApp?: Enhancer<AppType>; enhanceComponent?: Enhancer<NextComponentType> } | Enhancer<NextComponentType>

DocumentContext

DocumentContext: NextPageContext & { renderPage: RenderPage }

DocumentInitialProps

DocumentInitialProps: RenderPageResult & { styles?: React.ReactElement[] | React.ReactFragment }

DocumentProps

DocumentProps: DocumentInitialProps & { __NEXT_DATA__: NEXT_DATA; ampPath: string; assetPrefix?: string; buildManifest: BuildManifest; canonicalBase: string; dangerousAsPath: string; devOnlyCacheBusterQueryString: string; docComponentsRendered: { Head?: boolean; Html?: boolean; Main?: boolean; NextScript?: boolean }; dynamicImports: ManifestItem[]; headTags: any[]; hybridAmp: boolean; inAmpMode: boolean; isDevelopment: boolean; locale?: string; scriptLoader: { defer?: string[]; eager?: any[] }; unstable_JsPreload?: false; unstable_runtimeJS?: false }

DocumentType

DocumentType: NextComponentType<DocumentContext, DocumentInitialProps, DocumentProps> & { renderDocument: any }

Enhancer

Enhancer<C>: (Component: C) => C

Type parameters

  • C

Type declaration

    • (Component: C): C

    • Parameters

      • Component: C

      Returns C

NEXT_DATA

NEXT_DATA: { appGip?: boolean; assetPrefix?: string; autoExport?: boolean; buildId: string; customServer?: boolean; defaultLocale?: string; domainLocales?: DomainLocales; dynamicIds?: string[]; err?: Error & { statusCode?: number }; gip?: boolean; gsp?: boolean; gssp?: boolean; isFallback?: boolean; isPreview?: boolean; locale?: string; locales?: string[]; nextExport?: boolean; page: string; props: Record<string, any>; query: ParsedUrlQuery; runtimeConfig?: {}; scriptLoader?: any[] }

Type declaration

  • Optional appGip?: boolean
  • Optional assetPrefix?: string
  • Optional autoExport?: boolean
  • buildId: string
  • Optional customServer?: boolean
  • Optional defaultLocale?: string
  • Optional domainLocales?: DomainLocales
  • Optional dynamicIds?: string[]
  • Optional err?: Error & { statusCode?: number }
  • Optional gip?: boolean
  • Optional gsp?: boolean
  • Optional gssp?: boolean
  • Optional isFallback?: boolean
  • Optional isPreview?: boolean
  • Optional locale?: string
  • Optional locales?: string[]
  • Optional nextExport?: boolean
  • page: string
  • props: Record<string, any>
  • query: ParsedUrlQuery
  • Optional runtimeConfig?: {}
    • [key: string]: any
  • Optional scriptLoader?: any[]

NextApiHandler

NextApiHandler<T>: (req: NextApiRequest, res: NextApiResponse<T>) => void | Promise<void>

Next API route handler

Type parameters

  • T = any

Type declaration

NextApiResponse

NextApiResponse<T>: ServerResponse & { clearPreviewData: () => NextApiResponse<T>; json: Send<T>; send: Send<T>; setPreviewData: (data: object | string, options?: { maxAge?: number }) => NextApiResponse<T>; status: (statusCode: number) => NextApiResponse<T>; redirect: any }

Next API route response

Type parameters

  • T = any

NextComponentType

NextComponentType<C, IP, P>: ComponentType<P> & { getInitialProps?: any }

Types used by both next and next-server

Type parameters

NextWebVitalsMetric

NextWebVitalsMetric: { id: string; label: string; name: string; startTime: number; value: number }

Web vitals provided to _app.reportWebVitals by Core Web Vitals plugin developed by Google Chrome team. https://nextjs.org/blog/next-9-4#integrated-web-vitals-reporting

Type declaration

  • id: string
  • label: string
  • name: string
  • startTime: number
  • value: number

RenderPage

RenderPage: (options?: ComponentsEnhancer) => RenderPageResult | Promise<RenderPageResult>

Type declaration

RenderPageResult

RenderPageResult: { head?: (JSX.Element | null)[]; html: string }

Type declaration

  • Optional head?: (JSX.Element | null)[]
  • html: string

Variables

Const SP

SP: boolean

Const ST

ST: boolean

Const urlObjectKeys

urlObjectKeys: string[]

Functions

execOnce

  • execOnce<T>(fn: T): T

  • Utils

    Type parameters

    • T: (...args: any[]) => ReturnType<T>

    Parameters

    • fn: T

    Returns T

formatWithValidation

  • formatWithValidation(url: UrlObject): string

  • Parameters

    • url: UrlObject

    Returns string

getDisplayName

  • getDisplayName<P>(Component: ComponentType<P>): string

  • Type parameters

    • P

    Parameters

    • Component: ComponentType<P>

    Returns string

getLocationOrigin

  • getLocationOrigin(): string

  • Returns string

getURL

  • getURL(): string

  • Returns string

isResSent

  • isResSent(res: ServerResponse): boolean

  • Parameters

    • res: ServerResponse

    Returns boolean

loadGetInitialProps

  • loadGetInitialProps<C, IP, P>(App: NextComponentType<C, IP, P>, ctx: C): Promise<IP>

  • Type parameters

    Parameters

    Returns Promise<IP>

Generated using TypeDoc