jimpex
    Preparing search index...

    Type Alias JimpexOptions

    The options to create a new instance of Jimpex.

    type JimpexOptions = {
        boot: boolean;
        config: JimpexConfigOptions;
        express: JimpexExpressOptions;
        filesizeLimit: string;
        healthCheck: JimpexHealthCheckFn;
        path: JimpexPathOptions;
        services: JimpexServicesOptions;
        statics: JimpexStaticsOptions;
    }
    Index

    Properties

    boot: boolean

    Whether or not to call the boot method after initialization. This is useful if you want to register/overwrite services only on certain contexts, like a dev environment.

    true
    

    Options for the configuration service.

    Options for the Express application.

    filesizeLimit: string

    The size limit for the requests payload.

    '15MB'
    
    healthCheck: JimpexHealthCheckFn

    A function that will be used to check the application health status.

    The options to configure the application executable path.

    Options to manage the default services.

    Options for the middleware that serves static files.