@adonisjs/auth/build/modules/basic_auth_guard/define_config.d.ts

Official authentication provider for Adonis framework

import type { HttpContext } from '@adonisjs/core/http';
import type { ConfigProvider } from '@adonisjs/core/types';
import { BasicAuthGuard } from './guard.ts';
import type { GuardConfigProvider } from '../../src/types.ts';
import { BasicAuthLucidUserProvider } from './user_providers/lucid.ts';
import type { LucidAuthenticatable, BasicAuthUserProviderContract, BasicAuthLucidUserProviderOptions } from './types.ts';
/**
 * Configures basic auth guard for authentication using HTTP Basic Authentication
 *
 * @param config - Configuration object containing the user provider
 *
 * @example
 * const guard = basicAuthGuard({
 *   provider: basicAuthUserProvider({
 *     model: () => import('#models/user')
 *   })
 * })
 */
export declare function basicAuthGuard<UserProvider extends BasicAuthUserProviderContract<unknown>>(config: {
    provider: UserProvider | ConfigProvider<UserProvider>;
}): GuardConfigProvider<(ctx: HttpContext) => BasicAuthGuard<UserProvider>>;
/**
 * Configures user provider that uses Lucid models to authenticate
 * users using basic auth credentials
 *
 * @param config - Configuration options for the Lucid user provider
 *
 * @example
 * const userProvider = basicAuthUserProvider({
 *   model: () => import('#models/user')
 * })
 */
export declare function basicAuthUserProvider<Model extends LucidAuthenticatable>(config: BasicAuthLucidUserProviderOptions<Model>): BasicAuthLucidUserProvider<Model>;