Class Router

constructor

• new Router(
      __namedParameters?: {
          basePath?: string;
          notFound?: NotFoundHandler;
          runtime?: RouterRuntime | null;
          useHistory?: boolean;
      },
  ): Router

  Parameters

  • __namedParameters: {
        basePath?: string;
        notFound?: NotFoundHandler;
        runtime?: RouterRuntime | null;
        useHistory?: boolean;
    } = {}

  Returns Router

basePath

currentPath

notFound

runtime

destroy

• destroy(): void

  Returns void

get

• get(path: string, handler: any): this

  Parameters

  • path: string
  • handler: any

  Returns this

go

• go(path: string, ctx?: Record<string, any>): Promise<any>

  Parameters

  • path: string
  • ctx: Record<string, any> = {}

  Returns Promise<any>

href

• href(path: string): string

  Parameters

  • path: string

  Returns string

mount

• mount(target: MountTarget, options?: RouterMountOptions): this

  Parameters

  • target: MountTarget
  • options: RouterMountOptions = {}

  Returns this

navigate

• navigate(path: string, __namedParameters?: RouterNavigateOptions): Promise<any>

  Parameters

  • path: string
  • __namedParameters: RouterNavigateOptions = {}

  Returns Promise<any>

onChange

• onChange(listener: RouterChangeListener): () => void

  Parameters

  • listener: RouterChangeListener

  Returns () => void

resolve

• resolve(path: string, ctx?: Record<string, any>): Promise<any>

  Parameters

  • path: string
  • ctx: Record<string, any> = {}

  Returns Promise<any>

set

• set(path: string, handler: any): this

  Parameters

  • path: string
  • handler: any

  Returns this

start

• start(path?: string, ctx?: Record<string, any>): Promise<any>

  Parameters

  • path: string = "/"
  • ctx: Record<string, any> = {}

  Returns Promise<any>