Sarraf API
    Preparing search index...

    Interface SarrafModuleAsyncOptions

    interface SarrafModuleAsyncOptions {
        imports?: (
            | DynamicModule
            | Type<any>
            | Promise<DynamicModule>
            | ForwardReference<any>
        )[];
        inject?: (string | symbol | Type<any>)[];
        logger?: Logger;
        useFactory: (
            ...deps: never[],
        ) =>
            | Sarraf<ProvidersConfig>
            | SarrafOptions<ProvidersConfig>
            | Promise<Sarraf<ProvidersConfig> | SarrafOptions<ProvidersConfig>>;
        webhooks?: false | SarrafWebhookOptions;
    }

    Hierarchy

    • ModuleOptions
      • SarrafModuleAsyncOptions
    Index
    imports?: (
        | DynamicModule
        | Type<any>
        | Promise<DynamicModule>
        | ForwardReference<any>
    )[]
    inject?: (string | symbol | Type<any>)[]
    logger?: Logger

    Default: the client's logger.

    useFactory: (
        ...deps: never[],
    ) =>
        | Sarraf<ProvidersConfig>
        | SarrafOptions<ProvidersConfig>
        | Promise<Sarraf<ProvidersConfig> | SarrafOptions<ProvidersConfig>>

    Returns a Sarraf client, or the options to create one (e.g. from ConfigService).

    webhooks?: false | SarrafWebhookOptions

    false registers no controller: call SarrafWebhooks.handle() from your own.