Interface NestConfig

interface NestConfig {
    abortOnError?: boolean;
    autoFlushLogs?: boolean;
    bodyParser?: boolean;
    bufferLogs?: boolean;
    cors?: boolean | CorsOptions | CorsOptionsDelegate<any>;
    forceCloseConnections?: boolean;
    httpsOptions?: HttpsOptions;
    logger?: false | LoggerService | LogLevel[];
    port: number;
    preview?: boolean;
    rawBody?: boolean;
    rootModule: any;
    snapshot?: boolean;
}

Hierarchy

  • NestApplicationOptions
    • NestConfig

Properties

abortOnError? autoFlushLogs? bodyParser? bufferLogs? cors? forceCloseConnections? httpsOptions? logger? port preview? rawBody? rootModule snapshot?

Properties

Optional abortOnError

abortOnError?: boolean

Whether to abort the process on Error. By default, the process is exited. Pass false to override the default behavior. If false is passed, Nest will not exit the application and instead will rethrow the exception.

Default

true

Optional autoFlushLogs

autoFlushLogs?: boolean

If enabled, logs will be automatically flushed and buffer detached when application initialization process either completes or fails.

Default

true

Optional bodyParser

bodyParser?: boolean

Whether to use underlying platform body parser.

Optional bufferLogs

bufferLogs?: boolean

If enabled, logs will be buffered until the "Logger#flush" method is called.

Default

false

Optional cors

cors?: boolean | CorsOptions | CorsOptionsDelegate<any>

CORS options from CORS package

Optional forceCloseConnections

forceCloseConnections?: boolean

Force close open HTTP connections. Useful if restarting your application hangs due to keep-alive connections in the HTTP adapter.

Optional httpsOptions

httpsOptions?: HttpsOptions

Set of configurable HTTPS options

Optional logger

logger?: false | LoggerService | LogLevel[]

Specifies the logger to use. Pass false to turn off logging.

port

port: number

Optional preview

preview?: boolean

Whether to run application in the preview mode. In the preview mode, providers/controllers are not instantiated & resolved.

Default

false

Optional rawBody

rawBody?: boolean

Whether to register the raw request body on the request. Use req.rawBody.

rootModule

rootModule: any

Optional snapshot

snapshot?: boolean

Whether to generate a serialized graph snapshot.

Default

false

Settings

Member Visibility

Theme

On This Page

abortOnErrorautoFlushLogsbodyParserbufferLogscorsforceCloseConnectionshttpsOptionsloggerportpreviewrawBodyrootModulesnapshot