Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RouteView

Hierarchy

  • RoutePayload
    • RouteView

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new RouteView(route: Route<DefaultDependencies>, component: ComponentType<object>, props?: {}): RouteView

  • create a route view.

    Parameters

    • route: Route<DefaultDependencies>

      router5 route object.

    • component: ComponentType<object>

      the React component to render.

    • props: {} = ...

      the props of the React component.

      • [key: string]: any

    Returns RouteView

Properties

component

component: ComponentType<object> = null

the component to render.

props

props: {} = null

the props for the component.

Type declaration

  • [key: string]: any

Accessors

route

  • get route(): Route<DefaultDependencies>

  • retrieve router5 route object.

    Returns Route<DefaultDependencies>

    the router5 route object.

Methods

getDataLoader

  • getDataLoader(key: any, defaultValue?: any): any

  • retrieve dataLoader data with optional default value.

    Parameters

    • key: any

      key of the dataLoader.

    • Optional defaultValue: any

      default value.

    Returns any

getExtra

  • getExtra(key: any, defaultValue?: any): any

  • retrieve extra data with optional default value.

    Parameters

    • key: any

      key of the extra.

    • Optional defaultValue: any

      default value.

    Returns any

setDataLoader

  • setDataLoader(key: any, value: any): RouteView

  • helper function to set dataLoader for chaining purpose.

    Parameters

    • key: any

      key of the dataLoader.

    • value: any

      value of the dataLoader.

    Returns RouteView

setExtra

  • helper function to set extra for chaining purpose.

    Parameters

    • key: any

      key of the extra.

    • value: any

      value of the extra.

    Returns RouteView

Generated using TypeDoc