@adonisjs/auth/build/src/middleware/initialize_auth_middleware.d.ts

Official authentication provider for Adonis framework

import type { HttpContext } from '@adonisjs/core/http';
import type { NextFn } from '@adonisjs/core/types/http';
import type { Authenticator } from '../authenticator.ts';
import type { Authenticators, GuardFactory } from '../types.ts';
/**
 * The "InitializeAuthMiddleware" is used to create a request
 * specific authenticator instance for every HTTP request.
 *
 * This middleware does not protect routes from unauthenticated
 * users. Please use the "auth" middleware for that.
 *
 * @example
 * router.use([() => import('#middleware/initialize_auth_middleware')])
 */
export default class InitializeAuthMiddleware {
    /**
     * Handle the HTTP request by initializing the authenticator
     *
     * @param ctx - The HTTP context
     * @param next - The next function to call in the middleware chain
     *
     * @example
     * // This middleware runs automatically when registered
     * // It adds ctx.auth to every HTTP request
     */
    handle(ctx: HttpContext, next: NextFn): Promise<any>;
}
declare module '@adonisjs/core/http' {
    interface HttpContext {
        auth: Authenticator<Authenticators extends Record<string, GuardFactory> ? Authenticators : never>;
    }
}