Options
All
  • Public
  • Public/Protected
  • All
Menu

Class JrouteHandler

Prepare controller, middleware handler

Hierarchy

  • JrouteHandler

Index

Constructors

constructor

Properties

app

app: any

baseUrl

baseUrl: string = ""

globalOptions

globalOptions: IControllerGlobal

json

json: any

options

options: IOptions

route

route: IJsonRoute

routeController

routeController: RouteController

Methods

add

  • add(verb: string, pattern: string, middleware: Array<any>, handler: any, controllerName: string, hasJwt?: boolean, hasCors: boolean): IRouteInfo
  • Add route

    Parameters

    • verb: string

      route verb

    • pattern: string

      route uri

    • middleware: Array<any>

      string or array of middleware

    • handler: any

      controller function

    • controllerName: string

      controller name

    • Default value hasJwt: boolean = false

      true if route is jwt protected

    • hasCors: boolean

      true if enabled

    Returns IRouteInfo

    route definition info

loadRoute

  • loadRoute(): any | boolean
  • Load a json definition file

    Returns any | boolean

    json data or false

parseRoutes

  • parseRoutes(uri: any, json: any): Array<IRouteInfo>
  • Create a route

    Parameters

    • uri: any

      single url object

    • json: any

      all route

    Returns Array<IRouteInfo>

    routes info definition for uri

set

setBaseUrl

  • setBaseUrl(globalBaseUrl?: string): string
  • Set base url for all route inside json definition. Add global.baseUrl to route url

    Parameters

    • Default value globalBaseUrl: string = ""

      global url string

    Returns string

    • baseurl string

Generated using TypeDoc