Class FrameworkConfig

Hierarchy

  • FrameworkConfig

Constructors

Properties

debug: boolean = false
debugBrokerHost: string = ...

Description

IP:Port or unix socket name or named pipes.

debugProfiler: boolean = true
debugStorePath: string = 'debug/'

Description

Relative to {varPath} option.

debugUrl: string = '_debug'
host: string = '0.0.0.0'
httpLog: boolean = true

Description

print http request logs to logger.

httpsPort?: number

Description

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

keepAliveTimeout?: number
maxPayload?: number
migrateOnStartup: boolean = false

Description

Whether all registered database should be migrated automatically on startup.

migrationDir: string = 'migrations'
path: string = '/'
port: number = 8080
publicDir?: string

Description

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

publicDirPrefix: string = '/'

Description

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

selfSigned?: boolean

Description

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

server?: any

Description

custom server created by node http/https module.

session?: any

Description

The session ClassType

ssl: boolean = false

Description

Enables HTTPS server.

sslCa?: string

Description

A file path to a ca file for https.

sslCertificate?: string

Description

A file path to a certificate file for https.

sslCrl?: string

Description

A file path to a ca file for https

sslKey?: string

Description

A file path to a ssl key file for https.

sslOptions?: any

Description

Same interface as tls.SecureContextOptions & tls.TlsOptions.

varPath: string = 'var/'
workers: number = 0

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.

Generated using TypeDoc