Class Router

Router class exposes a unified API to register new routes, group them or create route resources.

const router = new Router()

router.get('/', async function () {
  // handle request
})

Index

Constructors

constructor

new Router(app: Application<any>, encryption: Encryption, qsParser: Qs): Router
Creates a new Router instance
Parameters
- app: Application<any>
  The AdonisJS application instance
- encryption: Encryption
  Encryption service for signed URLs
- qsParser: Qs
  Query string parser for URL generation
Returns Router
- Defined in src/router/main.ts:153

Properties

usingDomains

usingDomains: boolean = false

A flag to know if routes for explicit domains have been registered. The boolean is computed after calling the "commit" method.

matchers

matchers: RouteMatchers = ...

Shortcut methods for commonly used route matchers

qs

qs: Qs

Query string parser for making URLs

urlBuilder

urlBuilder: {
urlFor: UrlFor<never>;
signedUrlFor: UrlFor<never, SignedURLOptions>;
}

The URLBuilder offers a type-safe API for creating URL for pre-registered routes or the route patterns.

We recommend using the URLBuilder over the "makeUrl" and "makeSignedUrl" methods.

Accessors

commited

get commited(): boolean
Check if routes have been committed to the store. Once routes are committed, defining new set of routes will have no impact

Returns boolean
- Defined in src/router/main.ts:121

Methods

parsePattern

parsePattern(pattern: string, matchers?: RouteMatchers): MatchItRouteToken[]
Parses the route pattern
Parameters
- pattern: string
  The route pattern to parse
- Optionalmatchers: RouteMatchers
  Optional route matchers
Returns MatchItRouteToken[]
- Defined in src/router/main.ts:190

use

use(middleware: LazyImport<MiddlewareAsClass>[]): this
Define an array of middleware to use on all the routes. Calling this method multiple times pushes to the existing list of middleware
Parameters
- middleware: LazyImport<MiddlewareAsClass>[]
  Array of middleware classes to apply globally
Returns this
Current Router instance for method chaining
- Defined in src/router/main.ts:201

named

named<NamedMiddleware extends Record<string, LazyImport<MiddlewareAsClass>>>(
    collection: NamedMiddleware,
): {
    [K in string | number | symbol]: <
        Args extends
            | []
            | [
                Parameters<
                    InstanceType<UnWrapLazyImport<NamedMiddleware[K]>>["handle"],
                >[2],
            ]
            | [
                Parameters<InstanceType<UnWrapLazyImport<(...)[(...)]>>["handle"]>[2]?,
            ],
    >(
        ...args: Args,
    ) => {
        name: K;
        reference: MiddlewareAsClass | LazyImport<MiddlewareAsClass>;
        args: Args[0];
        handle: (
            resolver: ContainerResolver<any>,
            ...args: [ctx: HttpContext, next: NextFn, params?: any],
        ) => any;
    }
}
Define a collection of named middleware. The defined collection is not registered anywhere, but instead converted in a new collection of functions you can apply on the routes, or router groups.
Type Parameters
- NamedMiddleware extends Record<string, LazyImport<MiddlewareAsClass>>
Parameters
- collection: NamedMiddleware
  Object mapping middleware names to middleware classes
Returns {
    [K in string | number | symbol]: <
        Args extends
            | []
            | [
                Parameters<
                    InstanceType<UnWrapLazyImport<NamedMiddleware[K]>>["handle"],
                >[2],
            ]
            | [
                Parameters<InstanceType<UnWrapLazyImport<(...)[(...)]>>["handle"]>[2]?,
            ],
    >(
        ...args: Args,
    ) => {
        name: K;
        reference: MiddlewareAsClass | LazyImport<MiddlewareAsClass>;
        args: Args[0];
        handle: (
            resolver: ContainerResolver<any>,
            ...args: [ctx: HttpContext, next: NextFn, params?: any],
        ) => any;
    }
}
Named middleware functions
- Defined in src/router/main.ts:219

route

route<T extends Constructor<any>>(
    pattern: string,
    methods: string[],
    handler: string | RouteFn | [T | LazyImport<T>, GetControllerHandlers<T>?],
): Route<T>
Add route for a given pattern and methods
Type Parameters
- T extends Constructor<any>
Parameters
- pattern: string
  The route pattern
- methods: string[]
  Array of HTTP methods
- handler: string | RouteFn | [T | LazyImport<T>, GetControllerHandlers<T>?]
  Route handler (function, string, or controller tuple)
Returns Route<T>
The created route instance
- Defined in src/router/main.ts:232

any

any<T extends Constructor<any>>(
pattern: string,
handler: string | RouteFn | [T | LazyImport<T>, GetControllerHandlers<T>?],
): Route<T>
Define a route that handles all common HTTP methods
Type Parameters
- T extends Constructor<any>
Parameters
- pattern: string
  The route pattern
- handler: string | RouteFn | [T | LazyImport<T>, GetControllerHandlers<T>?]
  Route handler (function, string, or controller tuple)
Returns Route<T>
The created route instance
- Defined in src/router/main.ts:254

get

get<T extends Constructor<any>>(
pattern: string,
handler: string | RouteFn | [T | LazyImport<T>, GetControllerHandlers<T>?],
): Route<T>
Define GET route
Type Parameters
- T extends Constructor<any>
Parameters
- pattern: string
  The route pattern
- handler: string | RouteFn | [T | LazyImport<T>, GetControllerHandlers<T>?]
  Route handler (function, string, or controller tuple)
Returns Route<T>
The created route instance
- Defined in src/router/main.ts:271

post

post<T extends Constructor<any>>(
pattern: string,
handler: string | RouteFn | [T | LazyImport<T>, GetControllerHandlers<T>?],
): Route<T>
Define POST route
Type Parameters
- T extends Constructor<any>
Parameters
- pattern: string
  The route pattern
- handler: string | RouteFn | [T | LazyImport<T>, GetControllerHandlers<T>?]
  Route handler (function, string, or controller tuple)
Returns Route<T>
The created route instance
- Defined in src/router/main.ts:284

put

put<T extends Constructor<any>>(
pattern: string,
handler: string | RouteFn | [T | LazyImport<T>, GetControllerHandlers<T>?],
): Route<T>
Define PUT route
Type Parameters
- T extends Constructor<any>
Parameters
- pattern: string
  The route pattern
- handler: string | RouteFn | [T | LazyImport<T>, GetControllerHandlers<T>?]
  Route handler (function, string, or controller tuple)
Returns Route<T>
The created route instance
- Defined in src/router/main.ts:297

patch

patch<T extends Constructor<any>>(
pattern: string,
handler: string | RouteFn | [T | LazyImport<T>, GetControllerHandlers<T>?],
): Route<T>
Define PATCH route
Type Parameters
- T extends Constructor<any>
Parameters
- pattern: string
  The route pattern
- handler: string | RouteFn | [T | LazyImport<T>, GetControllerHandlers<T>?]
  Route handler (function, string, or controller tuple)
Returns Route<T>
The created route instance
- Defined in src/router/main.ts:310

delete

delete<T extends Constructor<any>>(
pattern: string,
handler: string | RouteFn | [T | LazyImport<T>, GetControllerHandlers<T>?],
): Route<T>
Define DELETE route
Type Parameters
- T extends Constructor<any>
Parameters
- pattern: string
  The route pattern
- handler: string | RouteFn | [T | LazyImport<T>, GetControllerHandlers<T>?]
  Route handler (function, string, or controller tuple)
Returns Route<T>
The created route instance
- Defined in src/router/main.ts:323

group

group(callback: () => void): RouteGroup
Creates a group of routes. A route group can apply transforms to routes in bulk
Parameters
- callback: () => void
  Function that defines routes within the group
Returns RouteGroup
The created route group instance
- Defined in src/router/main.ts:336

resource

resource(
resource: string,
controller: string | Constructor<any> | LazyImport<Constructor<any>>,
): RouteResource<ResourceActionNames>
Registers a route resource with conventional set of routes
Parameters
- resource: string
  The resource name
- controller: string | Constructor<any> | LazyImport<Constructor<any>>
  Controller to handle the resource
Returns RouteResource<ResourceActionNames>
The created route resource instance
- Defined in src/router/main.ts:373

shallowResource

shallowResource(
resource: string,
controller: string | Constructor<any> | LazyImport<Constructor<any>>,
): RouteResource<ResourceActionNames>
Register a route resource with shallow nested routes.
Parameters
- resource: string
  The resource name
- controller: string | Constructor<any> | LazyImport<Constructor<any>>
  Controller to handle the resource
Returns RouteResource<ResourceActionNames>
The created route resource instance
- Defined in src/router/main.ts:391

on

on(pattern: string): BriskRoute
Returns a brisk route instance for a given URL pattern
Parameters
- pattern: string
  The route pattern
Returns BriskRoute
The created brisk route instance
- Defined in src/router/main.ts:411

where

where(param: string, matcher: string | RegExp | RouteMatcher): this
Define matcher for a given param. The global params are applied on all the routes (unless overridden at the route level).
Parameters
- param: string
  The parameter name to match
- matcher: string | RegExp | RouteMatcher
  The matcher pattern (RegExp, string, or RouteMatcher)
Returns this
Current Router instance for method chaining
- Defined in src/router/main.ts:428

commit

commit(): void
Commit routes to the store. The router is freezed after the commit method is called.

Returns void
- Defined in src/router/main.ts:444

find

find(
    routeIdentifier: string,
    domain?: string,
    method?: string,
    disableLegacyLookup?: boolean,
): null | RouteJSON
Finds a route by its identifier. The identifier can be the route name, controller.method name or the route pattern itself.

When "disableLegacyLookup" is set, the lookup will be performed only using the route name
Parameters
- routeIdentifier: string
  Route name, pattern, or controller reference
- Optionaldomain: string
  Optional domain to search within
- Optionalmethod: string
  Optional HTTP method to filter by
- OptionaldisableLegacyLookup: boolean
  Whether to disable legacy lookup strategies
Returns null | RouteJSON
Found route or null if not found
- Defined in src/router/main.ts:505

findOrFail

findOrFail(
    routeIdentifier: string,
    domain?: string,
    method?: string,
    disableLegacyLookup?: boolean,
): RouteJSON
Finds a route by its identifier. The identifier can be the route name, controller.method name or the route pattern itself.

An error is raised when unable to find the route.

When "disableLegacyLookup" is set, the lookup will be performed only using the route name
Parameters
- routeIdentifier: string
  Route name, pattern, or controller reference
- Optionaldomain: string
  Optional domain to search within
- Optionalmethod: string
  Optional HTTP method to filter by
- OptionaldisableLegacyLookup: boolean
  Whether to disable legacy lookup strategies
Returns RouteJSON
Found route

Throws
Error when route is not found
- Defined in src/router/main.ts:578

has

has(
    routeIdentifier: string,
    domain?: string,
    method?: string,
    followLookupStrategy?: boolean,
): boolean
Check if a route exists. The identifier can be the route name, controller.method name or the route pattern itself.

When "followLookupStrategy" is enabled, the lookup will be performed on the basis of the lookup strategy enabled via the "lookupStrategies" method. The default lookupStrategy is "name" and "pattern".
Parameters
- routeIdentifier: string
  Route name, pattern, or controller reference
- Optionaldomain: string
  Optional domain to search within
- Optionalmethod: string
  Optional HTTP method to filter by
- OptionalfollowLookupStrategy: boolean
  Whether to follow the configured lookup strategy
Returns boolean
True if route exists, false otherwise
- Defined in src/router/main.ts:606

toJSON

toJSON(): { [domain: string]: RouteJSON[] }
Returns a list of routes grouped by their domain names

Returns { [domain: string]: RouteJSON[] }
Object mapping domain names to route arrays
- Defined in src/router/main.ts:619

generateTypes

generateTypes(indentation?: number): string
Generates types for the URL builder. These types must be written inside a file for the URL builder to pick them up.
Parameters
- indentation: number = 0
  Indentation level for generated types
Returns string
Generated TypeScript types as string
- Defined in src/router/main.ts:630

match

match(
    uri: string,
    method: string,
    shouldDecodeParam: boolean,
    hostname?: null | string,
): null | MatchedRoute
Find route for a given URL, method and optionally domain
Parameters
- uri: string
  The URI to match
- method: string
  HTTP method
- shouldDecodeParam: boolean
  Whether to decode parameters
- Optionalhostname: null | string
  Optional hostname for domain matching
Returns null | MatchedRoute
Matched route or null if no match found
- Defined in src/router/main.ts:744

builder

builder(): UrlBuilder
Create URL builder instance.

Returns UrlBuilder
Deprecated
Instead use "@adonisjs/core/services/url_builder" instead
- Defined in src/router/main.ts:764

builderForDomain

builderForDomain(domain: string): UrlBuilder
Create URL builder instance for a given domain.
Parameters
- domain: string
Returns UrlBuilder
Deprecated
Instead use "@adonisjs/core/services/url_builder"
- Defined in src/router/main.ts:774

makeUrl

makeUrl(
    routeIdentifier: string,
    params?: any[] | Record<string, any>,
    options?: MakeUrlOptions,
): string
Make URL to a pre-registered route
Parameters
- routeIdentifier: string
- Optionalparams: any[] | Record<string, any>
- Optionaloptions: MakeUrlOptions
Returns string
Deprecated
Instead use "@adonisjs/core/services/url_builder"
- Defined in src/router/main.ts:784

makeSignedUrl

makeSignedUrl(
    routeIdentifier: string,
    params?: any[] | Record<string, any>,
    options?: MakeSignedUrlOptions,
): string
Makes a signed URL to a pre-registered route.
Parameters
- routeIdentifier: string
- Optionalparams: any[] | Record<string, any>
- Optionaloptions: MakeSignedUrlOptions
Returns string
Deprecated
Instead use "@adonisjs/core/services/url_builder"
- Defined in src/router/main.ts:811

Class Router

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Router

Properties

usingDomains

matchers

qs

urlBuilder

Accessors

commited

Returns boolean

Methods

parsePattern

Parameters

Returns MatchItRouteToken[]

use

Parameters

Returns this

named

Type Parameters

Parameters

route

Type Parameters

Parameters

Returns Route<T>

any

Type Parameters

Parameters

Returns Route<T>

get

Type Parameters

Parameters

Returns Route<T>

post

Type Parameters

Parameters

Returns Route<T>

put

Type Parameters

Parameters

Returns Route<T>

patch

Type Parameters

Parameters

Returns Route<T>

delete

Type Parameters

Parameters

Returns Route<T>

group

Parameters

Returns RouteGroup

resource

Parameters

Returns RouteResource<ResourceActionNames>

shallowResource

Parameters

Returns RouteResource<ResourceActionNames>

on

Parameters

Returns BriskRoute

where

Parameters

Returns this

commit

Returns void

find

Parameters

Returns null | RouteJSON

findOrFail

Parameters

Returns RouteJSON

Throws