Options
All
  • Public
  • Public/Protected
  • All
Menu

Module next-server/lib/router/router

Index

Classes

Type aliases

Functions

Type aliases

AppComponent

AppComponent: ComponentType<AppProps>

AppProps

AppProps: Pick<CompletePrivateRouteInfo, "Component" | "err"> & { router: default } & Record<string, any>

BaseRouter

BaseRouter: { asPath: string; basePath: string; defaultLocale?: string; domainLocales?: DomainLocales; isLocaleDomain: boolean; locale?: string; locales?: string[]; pathname: string; query: ParsedUrlQuery; route: string }

Type declaration

  • asPath: string
  • basePath: string
  • Optional defaultLocale?: string
  • Optional domainLocales?: DomainLocales
  • isLocaleDomain: boolean
  • Optional locale?: string
  • Optional locales?: string[]
  • pathname: string
  • query: ParsedUrlQuery
  • route: string

CompletePrivateRouteInfo

CompletePrivateRouteInfo: { Component: ComponentType; __N_SSG?: boolean; __N_SSP?: boolean; err?: Error; error?: any; props?: Record<string, any>; styleSheets: StyleSheetTuple[] }

Type declaration

  • Component: ComponentType
  • Optional __N_SSG?: boolean
  • Optional __N_SSP?: boolean
  • Optional err?: Error
  • Optional error?: any
  • Optional props?: Record<string, any>
  • styleSheets: StyleSheetTuple[]

NextRouter

NextRouter: BaseRouter & Pick<default, "push" | "replace" | "reload" | "back" | "prefetch" | "beforePopState" | "events" | "isFallback" | "isReady" | "isPreview">

PrefetchOptions

PrefetchOptions: { locale?: string | false; priority?: boolean }

Type declaration

  • Optional locale?: string | false
  • Optional priority?: boolean

PrivateRouteInfo

PrivateRouteInfo: (Omit<CompletePrivateRouteInfo, "styleSheets"> & { initial: true }) | CompletePrivateRouteInfo

Functions

addBasePath

  • addBasePath(path: string): string

  • Parameters

    • path: string

    Returns string

addLocale

  • addLocale(path: string, locale?: string | false, defaultLocale?: string): string

  • Parameters

    • path: string
    • Optional locale: string | false
    • Optional defaultLocale: string

    Returns string

delBasePath

  • delBasePath(path: string): string

  • Parameters

    • path: string

    Returns string

delLocale

  • delLocale(path: string, locale?: string): string

  • Parameters

    • path: string
    • Optional locale: string

    Returns string

getDomainLocale

  • getDomainLocale(path: string, locale?: string | false, locales?: string[], domainLocales?: DomainLocales): string | false

  • Parameters

    • path: string
    • Optional locale: string | false
    • Optional locales: string[]
    • Optional domainLocales: DomainLocales

    Returns string | false

hasBasePath

  • hasBasePath(path: string): boolean

  • Parameters

    • path: string

    Returns boolean

interpolateAs

  • interpolateAs(route: string, asPathname: string, query: ParsedUrlQuery): { params: string[]; result: string }

  • Parameters

    • route: string
    • asPathname: string
    • query: ParsedUrlQuery

    Returns { params: string[]; result: string }

    • params: string[]
    • result: string

isLocalURL

  • isLocalURL(url: string): boolean

  • Detects whether a given url is routable by the Next.js router (browser only).

    Parameters

    • url: string

    Returns boolean

resolveHref

  • resolveHref(currentPath: string, href: Url, resolveAs?: boolean): string

  • Resolves a given hyperlink with a certain router state (basePath not included). Preserves absolute urls.

    Parameters

    • currentPath: string
    • href: Url
    • Optional resolveAs: boolean

    Returns string

Generated using TypeDoc