Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RouteFactory

Hierarchy

  • RouteFactory

Index

Methods

Methods

createBase

  • createBase(settings: RouteSettings, children: RouteConfig[]): RouteConfig

  • Create the base for the routes based on the settings and add the children to it

    Parameters

    • settings: RouteSettings

      the settings for which the route is being created

    • children: RouteConfig[]

    Returns RouteConfig

createConfig

  • createConfig(path: string, name: string, component: any, auth: boolean, admin: boolean, title: string, cantSeeWhenLoggedIn?: boolean): RouteConfig

  • Create a standard route config

    Parameters

    • path: string

      the name of the path for the route config

    • name: string

      the name of the route

    • component: any

      the component to render for this route

    • auth: boolean

      if you need to be authenticated to see this route

    • admin: boolean

      if you need to be admin to see the route

    • title: string

      the title of the route

    • Optional cantSeeWhenLoggedIn: boolean

    Returns RouteConfig

createCreate

  • Create a create route for the given settings

    Parameters

    • settings: RouteSettings

      the settings for which the route is being created

    Returns RouteConfig

createEdit

  • Create a create route for the given settings

    Parameters

    • settings: RouteSettings

      the settings for which the route is being created

    Returns RouteConfig

createOverview

  • Create an overview route for the given settings

    Parameters

    • settings: RouteSettings

      the settings for which the route is being created

    Returns RouteConfig

createShow

  • Create a create route for the given settings

    Parameters

    • settings: RouteSettings

      the settings for which the route is being created

    Returns RouteConfig

Generated using TypeDoc