Options
All
  • Public
  • Public/Protected
  • All
Menu

Module client/router

Index

References

NextRouter

Re-exports NextRouter

Router

Renames and exports default

withRouter

Renames and exports default

Type aliases

SingletonRouter

SingletonRouter: SingletonRouterBase & NextRouter

Variables

Const default

Functions

Const createRouter

  • createRouter(pathname: string, query: ParsedUrlQuery, as: string, __namedParameters: { App: ComponentType<AppProps>; Component: ComponentType<{}>; defaultLocale?: string; domainLocales?: DomainLocales; err?: Error; initialProps: any; isFallback: boolean; isPreview?: boolean; locale?: string; locales?: string[]; pageLoader: any; subscription: (data: PrivateRouteInfo, App: ComponentType<AppProps>, resetScroll: null | { x: number; y: number }) => Promise<void>; wrapApp: (App: ComponentType<AppProps>) => any }): default
  • Parameters

    • pathname: string
    • query: ParsedUrlQuery
    • as: string
    • __namedParameters: { App: ComponentType<AppProps>; Component: ComponentType<{}>; defaultLocale?: string; domainLocales?: DomainLocales; err?: Error; initialProps: any; isFallback: boolean; isPreview?: boolean; locale?: string; locales?: string[]; pageLoader: any; subscription: (data: PrivateRouteInfo, App: ComponentType<AppProps>, resetScroll: null | { x: number; y: number }) => Promise<void>; wrapApp: (App: ComponentType<AppProps>) => any }
      • App: ComponentType<AppProps>
      • Component: ComponentType<{}>
      • Optional defaultLocale?: string
      • Optional domainLocales?: DomainLocales
      • Optional err?: Error
      • initialProps: any
      • isFallback: boolean
      • Optional isPreview?: boolean
      • Optional locale?: string
      • Optional locales?: string[]
      • pageLoader: any
      • subscription: (data: PrivateRouteInfo, App: ComponentType<AppProps>, resetScroll: null | { x: number; y: number }) => Promise<void>
          • Parameters

            Returns Promise<void>

      • wrapApp: (App: ComponentType<AppProps>) => any
          • Parameters

            Returns any

    Returns default

makePublicRouterInstance

  • Parameters

    Returns NextRouter

useRouter

  • Returns NextRouter

Generated using TypeDoc