Class FrameworkModule

constructor

• new FrameworkModule(config?: {
      debug?: boolean;
      debugBrokerHost?: string;
      debugProfiler?: boolean;
      debugStorePath?: string;
      debugUrl?: string;
      host?: string;
      httpLog?: boolean;
      httpsPort?: number;
      keepAliveTimeout?: number;
      maxPayload?: number;
      migrateOnStartup?: boolean;
      migrationDir?: string;
      path?: string;
      port?: number;
      publicDir?: string;
      publicDirPrefix?: string;
      selfSigned?: boolean;
      server?: any;
      session?: any;
      ssl?: boolean;
      sslCa?: string;
      sslCertificate?: string;
      sslCrl?: string;
      sslKey?: string;
      sslOptions?: any;
      varPath?: string;
      workers?: number;
  }): FrameworkModule

• Parameters

  • Optional config: {
        debug?: boolean;
        debugBrokerHost?: string;
        debugProfiler?: boolean;
        debugStorePath?: string;
        debugUrl?: string;
        host?: string;
        httpLog?: boolean;
        httpsPort?: number;
        keepAliveTimeout?: number;
        maxPayload?: number;
        migrateOnStartup?: boolean;
        migrationDir?: string;
        path?: string;
        port?: number;
        publicDir?: string;
        publicDirPrefix?: string;
        selfSigned?: boolean;
        server?: any;
        session?: any;
        ssl?: boolean;
        sslCa?: string;
        sslCertificate?: string;
        sslCrl?: string;
        sslKey?: string;
        sslOptions?: any;
        varPath?: string;
        workers?: number;
    }

    • Optional debug?: boolean

    • Optional debugBrokerHost?: string

      Description

      IP:Port or unix socket name or named pipes.

    • Optional debugProfiler?: boolean

    • Optional debugStorePath?: string

      Description

      Relative to {varPath} option.

    • Optional debugUrl?: string

    • Optional host?: string

    • Optional httpLog?: boolean

      Description

      print http request logs to logger.

    • Optional httpsPort?: number

      Description

      If httpsPort and ssl is defined, then the https server is started additional to the http-server.

    • Optional keepAliveTimeout?: number

    • Optional maxPayload?: number

    • Optional migrateOnStartup?: boolean

      Description

      Whether all registered database should be migrated automatically on startup.

    • Optional migrationDir?: string

    • Optional path?: string

    • Optional port?: number

    • Optional publicDir?: string

      Description

      A path to a folder that should be served per default. Relative to cwd.

    • Optional publicDirPrefix?: string

      Description

      Per default the folder specified in publicDir is available under /. Change that to a URL prefix of your choice.

    • Optional selfSigned?: boolean

      Description

      If for ssl: true the certificate and key should be automatically generated.

    • Optional server?: any

      Description

      custom server created by node http/https module.

    • Optional session?: any

      Description

      The session ClassType

    • Optional ssl?: boolean

      Description

      Enables HTTPS server.

    • Optional sslCa?: string

      Description

      A file path to a ca file for https.

    • Optional sslCertificate?: string

      Description

      A file path to a certificate file for https.

    • Optional sslCrl?: string

      Description

      A file path to a ca file for https

    • Optional sslKey?: string

      Description

      A file path to a ssl key file for https.

    • Optional sslOptions?: any

      Description

      Same interface as tls.SecureContextOptions & tls.TlsOptions.

    • Optional varPath?: string

    • Optional workers?: number

      Description

      A value of 0 means the main process handles requests alone. A value of > 0 means the main process does not handle any requests and anything is redirected to workers.

  Returns FrameworkModule