zibri
    Preparing search index...

    Type Alias ZibriApplicationOptions

    All options for a Zibri application.

    type ZibriApplicationOptions = {
        authStrategies?: AuthStrategies;
        baseUrl: string;
        bodyParsers?: Newable<BodyParserInterface>[];
        controllers: Newable<unknown>[];
        cronJobs?: Newable<CronJob>[];
        dataSources?: Newable<DataSourceInterface>[];
        name: string;
        plugins?: ZibriPlugin[];
        providers?: DiProvider<unknown>[];
        twoFactorMethods?: TwoFactorMethods;
        version: Version;
        websocketControllers: Newable<unknown>[];
    }
    Index

    Properties

    authStrategies? baseUrl bodyParsers? controllers cronJobs? dataSources? name plugins? providers? twoFactorMethods? version websocketControllers

    Properties

    authStrategies?: AuthStrategies

    The auth strategies to register.

    If nothing is provided, the Zibri default jwt auth strategy will be used.

    baseUrl: string

    The base url of the app. Eg. Http://localhost:3000.

    bodyParsers?: Newable<BodyParserInterface>[]

    The body parsers to register.

    If nothing is provided, the Zibri default parsers will be used.

    controllers: Newable<unknown>[]

    The controllers to register in the app.

    cronJobs?: Newable<CronJob>[]

    The cron jobs to register in the app.

    dataSources?: Newable<DataSourceInterface>[]

    The data sources to register in the app.

    name: string

    The name of the app.

    plugins?: ZibriPlugin[]

    The plugins to be used.

    providers?: DiProvider<unknown>[]

    The DI providers to register/override.

    twoFactorMethods?: TwoFactorMethods

    The two factor methods to register.

    If nothing is provided, the Zibri default otp two factor method will be used.

    version: Version

    The SemVer version of the app.

    Is also used by migrations by default.

    websocketControllers: Newable<unknown>[]

    The websocket controllers to register in the app.

    Settings

    Member Visibility

    On This Page

    Properties