This commit is contained in:
Tutur33
2023-11-24 22:35:41 +01:00
parent 3c0b507a93
commit 7644b2a0f7
45165 changed files with 4803356 additions and 3 deletions
+53
View File
@@ -0,0 +1,53 @@
/**
* @adonisjs/http-server
*
* (c) Harminder Virk <virk@adonisjs.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
/// <reference path="../../adonis-typings/index.d.ts" />
import { Macroable } from 'macroable';
import { Route } from './Route';
import { BriskRouteContract, RouteMatchersNode, RouteHandler, MakeUrlOptions } from '@ioc:Adonis/Core/Route';
/**
* Brisk route enables you to expose expressive API for
* defining route handler.
*
* For example: AdonisJs uses [[BriskRoute]] `Route.on().render()`
* to render a view without defining a controller method or
* closure.
*/
export declare class BriskRoute extends Macroable implements BriskRouteContract {
private pattern;
private globalMatchers;
protected static macros: {};
protected static getters: {};
/**
* Invoked by is reference to the parent method that calls `setHandler` on
* this class. We keep a reference to the parent method name for raising
* meaningful exception
*/
private invokedBy;
/**
* Reference to route instance. Set after `setHandler` is called
*/
route: null | Route;
constructor(pattern: string, globalMatchers: RouteMatchersNode);
/**
* Set handler for the brisk route. The `invokedBy` string is the reference
* to the method that calls this method. It is required to create human
* readable error message when `setHandler` is called for multiple
* times.
*/
setHandler(handler: RouteHandler, invokedBy: string, methods?: string[]): Route;
/**
* Redirect to a given route. Params from the original request will be used when no
* custom params are defined
*/
redirect(identifier: string, params?: any[] | Record<string, any>, options?: MakeUrlOptions): Route;
/**
* Redirect request to a fixed path
*/
redirectToPath(url: string): Route;
}