@wristband/nestjs-auth/dist/types/express/express-auth.module.d.ts

SDK for integrating your NestJS application with Wristband. Handles user authentication and token management.

import { DynamicModule } from '@nestjs/common';
import { AuthConfig } from '../types';
/**
 * The WristbandExpressAuthModule is a dynamic NestJS module that integrates the Wristband Authentication Service
 * for NestJS/Express-based applications. It allows for the configuration and injection of the
 * `WristbandExpressAuthService`, enabling authentication functionality within the application.
 *
 * It offers a flexible setup through its `forRoot` method, allowing configuration of the service with custom
 * `AuthConfig` as well as custom names for service injection, ensuring flexibility when multiple instances are
 * required.
 *
 * Usage:
 * - Call `forRoot` with the desired `AuthConfig` and an optional token name to set up the module.
 * - The module exports the `WristbandExpressAuthService` and any custom token provided, making it available across the app.
 *
 * Example:
 *
 * ```typescript
 * WristbandExpressAuthModule.forRoot({ clientId: 'your-client-id', clientSecret: 'your-client-secret' });
 * ```
 *
 * This module is designed to be globally available, ensuring the `WristbandExpressAuthService` can be easily injected
 * and used across different modules in the application.
 */
export declare class WristbandExpressAuthModule {
    /**
     * Configures and initializes the WristbandExpressAuthModule with the provided authentication configuration.
     *
     * Example:
     *
     * ```typescript
     * WristbandExpressAuthModule.forRoot({
     *   clientId: 'your-client-id',
     *   clientSecret: 'your-client-secret',
     *   ...
     * }, 'myWristbandAuth');
     * ```
     *
     * @param {AuthConfig} config - The configuration object for the Wristband SDK, containing authentication details
     * such as `clientId`, `clientSecret`, and other relevant settings.
     * @param {string} [token='wristband'] - Optional token name used to identify the service in the module's context.
     * Defaults to `'wristband'` if not provided, enabling support for multiple instances of the service.
     * @returns {DynamicModule} - A NestJS DynamicModule that provides and exports the `WristbandExpressAuthService`
     * and the custom token.
     */
    static forRoot(config: AuthConfig, token?: string): DynamicModule;
}