Class Redirect

Exposes the API to construct redirect routes

Index

Constructors

Methods

status clearQs withQs back toRoute toPath

Constructors

constructor

new Redirect(
    request: IncomingMessage,
    response: Response,
    router: Router,
    qs: Qs,
): Redirect
Creates a new Redirect instance for handling HTTP redirects
Parameters
- request: IncomingMessage
  Node.js incoming HTTP request
- response: Response
  AdonisJS response instance
- router: Router
  AdonisJS router instance
- qs: Qs
  Query string parser instance
Returns Redirect
- Defined in src/redirect.ts:72

Methods

status

status(statusCode: number): this
Sets a custom HTTP status code for the redirect response
Parameters
- statusCode: number
  HTTP status code to use (e.g., 301, 302, 307)
Returns this
The Redirect instance for method chaining
- Defined in src/redirect.ts:110

clearQs

clearQs(): this
Clears any query string values previously added using the withQs method

Returns this
The Redirect instance for method chaining
- Defined in src/redirect.ts:119

withQs

withQs(): this
Forwards the current request's query string to the redirect URL

Use this overload when you want to preserve all existing query parameters from the current request in the redirect URL.

Returns this
The Redirect instance for method chaining
Example
```
// If current URL is '/search?q=hello&page=2'
response.redirect().withQs().toPath('/results')
// Redirects to: '/results?q=hello&page=2'
```
- Defined in src/redirect.ts:140
withQs(values: Record<string, any>): this
Adds multiple query string parameters to the redirect URL

Use this overload when you want to add several query parameters at once using an object with key-value pairs.
Parameters
- values: Record<string, any>
  Object containing query parameter names and values
Returns this
The Redirect instance for method chaining
Example
```
response.redirect().withQs({ page: 1, sort: 'name' }).toPath('/users')
// Redirects to: '/users?page=1&sort=name'
```
- Defined in src/redirect.ts:156
withQs(name: string, value: any): this
Adds a single query string parameter to the redirect URL

Use this overload when you want to add just one query parameter with a specific name and value.
Parameters
- name: string
  The query parameter name
- value: any
  The query parameter value
Returns this
The Redirect instance for method chaining
Example
```
response.redirect().withQs('success', 'true').toPath('/dashboard')
// Redirects to: '/dashboard?success=true'
```
- Defined in src/redirect.ts:173

back

back(): void
Redirects to the previous path using the Referer header Falls back to '/' if no referrer is found

Returns void
- Defined in src/redirect.ts:193

toRoute

toRoute<Identifier extends string>(...args: []): void
Redirects to a route using its identifier (name, pattern, or handler reference)
Type Parameters
- Identifier extends string
Parameters
- ...args: []
  Route identifier, parameters, and options for URL building
Returns void
- Defined in src/redirect.ts:224

toPath

toPath(url: string): void
Redirects to a specific URL path
Parameters
- url: string
  Target URL path for redirection
Returns void
- Defined in src/redirect.ts:243