Class BriskRoute

constructor

• new BriskRoute(
      app: Application<any>,
      routerMiddleware: ParsedGlobalMiddleware[],
      options: { pattern: string; globalMatchers: RouteMatchers },
  ): BriskRoute

  Creates a new BriskRoute instance

  Parameters

  • app: Application<any>

    The AdonisJS application instance

  • routerMiddleware: ParsedGlobalMiddleware[]

    Array of global middleware registered on the router

  • options: { pattern: string; globalMatchers: RouteMatchers }

    Configuration options for the brisk route

  Returns BriskRoute

route

setHandler

• setHandler(handler: RouteFn): Route

  Set handler for the brisk route

  Parameters

  • handler: RouteFn

    The route handler function

  Returns Route

  The created route instance

redirect

• redirect<Identifier extends string>(...args: []): Route

  Redirects to a given route. Params from the original request will be used when no custom params are defined.

  Type Parameters

  • Identifier extends string

  Parameters

  • ...args: []

    Route identifier, parameters, and options for building the redirect URL

  Returns Route

  The created route instance

redirectToPath

• redirectToPath(url: string, options?: { status: number }): Route

  Redirect request to a fixed URL

  Parameters

  • url: string

    The URL to redirect to

  • Optionaloptions: { status: number }

    Optional redirect options including HTTP status code

  Returns Route

  The created route instance