@tsed/common/lib/config/interfaces/index.d.ts

A TypeScript Framework on top of Express

/// <reference types="node" />
import { Env, Type } from "@tsed/core";
import Https from "https";
import { ConverterSettings } from "./ConverterSettings";
import { EndpointDirectoriesSettings } from "./EndpointDirectoriesSettings";
import { PlatformLoggerSettings } from "./PlatformLoggerSettings";
import { PlatformMulterSettings } from "./PlatformMulterSettings";
import { PlatformStaticsSettings } from "./PlatformStaticsSettings";
import { PlatformViewsSettings } from "./PlatformViewsSettings";
import { ResponseFilterMethods } from "../../platform-response-filter/interfaces/ResponseFilterMethods";
declare global {
    namespace TsED {
        interface Configuration {
            /**
             * The root directory where you build run project. By default, it's equal to `process.cwd().
             */
            rootDir: string;
            /**
             * The environment profile. By default the environment profile is equals to `NODE_ENV`.
             */
            env: Env;
            /**
             * Port number for the [HTTP.Server](https://nodejs.org/api/http.html#http_class_http_server).
             */
            port: string | number;
            /**
             * Port number for the [HTTP.Server](https://nodejs.org/api/http.html#http_class_http_server).
             */
            httpPort: string | number | boolean;
            /**
             * Port number for the [HTTPs.Server](https://nodejs.org/api/https.html#https_class_https_server).
             */
            httpsPort: string | number | boolean;
            /**
             * [Https.ServerOptions](https://nodejs.org/api/tls.html#tls_tls_createserver_options_secureconnectionlistener)):
             * - `key` &lt;string&gt; | &lt;string[]&gt; | [&lt;Buffer&gt;](https://nodejs.org/api/buffer.html#buffer_class_buffer) | &lt;Object[]&gt;: The private key of the server in PEM format. To support multiple keys using different algorithms an array can be provided either as a plain array of key strings or an array of objects in the format `{pem: key, passphrase: passphrase}`. This option is required for ciphers that make use of private keys.
             * - `passphrase` &lt;string&gt; A string containing the passphrase for the private key or pfx.
             * - `cert` &lt;string&gt; | &lt;string[]&gt; | [&lt;Buffer&gt;](https://nodejs.org/api/buffer.html#buffer_class_buffer) | [&lt;Buffer[]&gt;](https://nodejs.org/api/buffer.html#buffer_class_buffer): A string, Buffer, array of strings, or array of Buffers containing the certificate key of the server in PEM format. (Required)
             * - `ca` &lt;string&gt; | &lt;string[]&gt; | [&lt;Buffer&gt;](https://nodejs.org/api/buffer.html#buffer_class_buffer) | [&lt;Buffer[]&gt;](https://nodejs.org/api/buffer.html#buffer_class_buffer): A string, Buffer, array of strings, or array of Buffers of trusted certificates in PEM format. If this is omitted several well known "root" CAs (like VeriSign) will be used. These are used to authorize connections.
             */
            httpsOptions: Https.ServerOptions;
            /**
             * Mount all controllers under a directories to an endpoint.
             */
            mount: EndpointDirectoriesSettings;
            /**
             * List of directories to scan [Services](/docs/services.md), [Middlewares](/docs/middlewares.md) or [Converters](/docs/converters.md).
             */
            componentsScan: (string | RegExp)[];
            /**
             * List of glob patterns. Exclude all files which matching with this list when Server scan all components with the `mount` or `scanComponents` options.
             */
            exclude: string[];
            /**
             * Configure the mimes accepted by default by the server.
             */
            acceptMimes: string[];
            /**
             * Enable debug mode. By default debug is false.
             */
            debug: boolean;
            /**
             * Converter configuration.
             */
            converter: Partial<ConverterSettings>;
            /**
             * Logger configuration.
             */
            logger: Partial<PlatformLoggerSettings>;
            /**
             * Object to mount all directories under to his endpoints. See more on [Serve Static](/tutorials/serve-static-files.md).
             */
            statics: PlatformStaticsSettings;
            /**
             * Object configure Multer. See more on [Upload file](/tutorials/serve-static-files.md).
             */
            multer: PlatformMulterSettings;
            /**
             * Object to configure Views engines with Consolidate. See more on [View engine](/docs/template-engine.md).
             */
            views: PlatformViewsSettings;
            /**
             * A list of response filters must be called before returning a response to the consumer. See more on [Response filters](/docs/response-filter.md).
             */
            responseFilters: Type<ResponseFilterMethods>[];
        }
    }
}
export * from "./PlatformLoggerSettings";
export * from "./EndpointDirectoriesSettings";
export * from "./PlatformStaticsSettings";
export * from "./PlatformMulterSettings";