@nestjs/common/interfaces/nest-application-options.interface.d.ts

Nest - modern, fast, powerful node.js web framework (@common)

import { CorsOptions, CorsOptionsDelegate } from './external/cors-options.interface.js';
import { HttpsOptions } from './external/https-options.interface.js';
import { NestApplicationContextOptions } from './nest-application-context-options.interface.js';
import { RouteConflictPolicy, RouteResolutionStrategy } from './router-options.interface.js';
/**
 * @publicApi
 */
export interface NestApplicationOptions extends NestApplicationContextOptions {
    /**
     * CORS options from [CORS package](https://github.com/expressjs/cors#configuration-options)
     */
    cors?: boolean | CorsOptions | CorsOptionsDelegate<any>;
    /**
     * Whether to use underlying platform body parser.
     */
    bodyParser?: boolean;
    /**
     * Set of configurable HTTPS options
     */
    httpsOptions?: HttpsOptions;
    /**
     * Whether to register the raw request body on the request. Use `req.rawBody`.
     */
    rawBody?: boolean;
    /**
     * Force close open HTTP connections. Useful if restarting your application hangs due to
     * keep-alive connections in the HTTP adapter.
     */
    forceCloseConnections?: boolean;
    /**
     * Whether to return 503 Service Unavailable for new requests during the shutdown process,
     * while allowing existing in-flight requests to complete.
     * @default false
     */
    return503OnClosing?: boolean;
    /**
     * Per-kind policy for overlapping HTTP routes detected at bootstrap.
     * Distinguishes `duplicate` (identical method+path+host+version) from
     * `shadow` (patterns that can match the same request, e.g. `/users/me`
     * vs `/users/:id`). Each kind defaults to `'off'`.
     */
    routeConflictPolicy?: RouteConflictPolicy;
    /**
     * Order in which HTTP routes are registered on the underlying adapter.
     * `'specificity'` registers literal segments before parametric and
     * wildcard ones on order-sensitive adapters (such as Express). Defaults
     * to `'declaration'`.
     */
    routeResolutionStrategy?: RouteResolutionStrategy;
}