Class RouteController<Params, Data, Context>

data

• get data(): Data

• The successfully loaded route data.

  Returns Data

error

• get error(): any

• The error that was thrown during component or data loading.

  Returns any

status

• get status():
      | "loading"
      | "error"
      | "not_found"
      | "redirect"
      | "ready"

• The current status of the controller:

  "loading"

  The route is being actively loaded.

  "ready"

  The route component and data were successfully loaded.

  "error"

  The route has thrown an error during rendering or from a data loader.

  "notFound"

  The route was marked as not found.

  "redirect"

  The route has requested a redirect.

  Returns
      | "loading"
      | "error"
      | "not_found"
      | "redirect"
      | "ready"

constructor

• new RouteController<Params, Data, Context>(router, route, params): RouteController<Params, Data, Context>

• Creates a new RouteController instance.

  Type Parameters

  • Params extends Dict = any

    Route params.
  • Data = any

    Data loaded by a route.
  • Context = any

    A router context.

  Parameters

  • router: Router<Context>

    The router that this controller belongs to.
  • route: Route<any, Params, Data, Context>

    The route this controller loads.
  • params: Params

    Route params.

  Returns RouteController<Params, Data, Context>

abort

• abort(reason?): void

• Instantly aborts the pending route loading for this controller.

  Parameters

  • reason: unknown = ...

    The abort reason that is used for rejection of the loading promise.

  Returns void

notFound

• notFound(): void

• Causes an enclosing Outlet to render a notFoundComponent.

  Returns void

redirect

• redirect(to): void

• Redirects the router to a new location.

  Parameters

  • to: string | To

    A location or a URL to redirect to.

  Returns void

reload

• reload(): AbortablePromise<Data>

• Reloads the data using dataLoader.

  Returns AbortablePromise<Data>

setData

• setData(data): void

• Loads route component, sets provided data and notifies router subscribers.

  Parameters

  • data: Data | PromiseLike<Data>

    The route data.

  Returns void

setError

• setError(error): void

• Sets an error and notifies router subscribers.

  Parameters

  • error: any

    The error.

  Returns void

childController

Readonlyparams

parentController

promise

Readonlyroute

Readonlyrouter