Interface Options

interface Options {
    adminPanel?: boolean;
    authRoutes?: boolean;
    controllers?: Controllers;
    ctx?: any;
    debug?: boolean;
    email?: EmailOptions;
    env?: any;
    exports?: any;
    firewall?: boolean | Firewall;
    name?: string;
    objectStateMapping?: ObjectStateMapping;
    objectVersion?: string;
    objects?: string[];
    requestParams?: RequestParams;
    routes?: Routes;
    scheduled?: ((params) => Promise<void>);
}

Properties

adminPanel? authRoutes? controllers? ctx? debug? email? env? exports? firewall? name? objectStateMapping? objectVersion? objects? requestParams? routes? scheduled?

Properties

Optional adminPanel

adminPanel?: boolean

Optional authRoutes

authRoutes?: boolean

Optional controllers

controllers?: Controllers

Optional ctx

ctx?: any

Optional debug

debug?: boolean

Optional email

email?: EmailOptions

Optional env

env?: any

Optional exports

exports?: any

Optional firewall

firewall?: boolean | Firewall

Optional name

name?: string

Optional objectStateMapping

objectStateMapping?: ObjectStateMapping

Optional objectVersion

objectVersion?: string

Optional objects

objects?: string[]

Optional requestParams

requestParams?: RequestParams

Optional routes

routes?: Routes

Optional scheduled

scheduled?: ((params) => Promise<void>)

Type declaration

    • (params): Promise<void>

    • Parameters

      Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc