ServerSettingsService Class

Module	import { ServerSettingsService } from "@tsed/common"
Source	/packages/common/src/config/services/ServerSettingsService.ts

Overview

class ServerSettingsService extends DIConfiguration {
    constructor();
    get version(): string;
    set version(v: string);
    get rootDir(): string;
    set rootDir(value: string);
    get port(): string | number | false;
    set port(value: string | number | false);
    get httpsOptions(): Https.ServerOptions;
    set httpsOptions(value: Https.ServerOptions);
    get httpPort(): string | number | false;
    set httpPort(value: string | number | false);
    get httpsPort(): string | number | false;
    set httpsPort(value: string | number | false);
    get uploadDir(): string;
    set uploadDir(value: string);
    get env(): Env;
    set env(value: Env);
    get mount(): EndpointDirectoriesSettings;
    set mount(value: EndpointDirectoriesSettings);
    get componentsScan(): string[];
    set componentsScan(value: string[]);
    get statics(): EndpointDirectoriesSettings;
    set statics(value: EndpointDirectoriesSettings);
    /**
     * @deprecated
     */
    get serveStatics(): EndpointDirectoriesSettings;
    /**
     * @deprecated
     */
    set serveStatics(value: EndpointDirectoriesSettings);
    get acceptMimes(): string[];
    set acceptMimes(value: string[]);
    get debug(): boolean;
    set debug(debug: boolean);
    /**
     * @deprecated
     */
    get validationModelStrict(): boolean;
    /**
     * @deprecated
     */
    set validationModelStrict(value: boolean);
    get converter(): Partial<IConverterSettings>;
    set converter(options: Partial<IConverterSettings>);
    get logger(): Partial<PlatformLoggerSettings>;
    set logger(value: Partial<PlatformLoggerSettings>);
    get exclude(): string[];
    set exclude(exclude: string[]);
    /**
     * @deprecated
     */
    get controllerScope(): ProviderScope;
    /**
     * @deprecated
     */
    set controllerScope(scope: ProviderScope);
    /**
     *
     * @returns {IRouterSettings}
     */
    get errors(): IErrorsSettings;
    /**
     *
     * @param {IRouterSettings} options
     */
    set errors(options: IErrorsSettings);
    /**
     *
     * @param addressPort
     * @returns {{address: string, port: number}}
     */
/**
 *
 * @returns <span class="token punctuation">{</span><span class="token keyword">string</span>|<span class="token keyword">number</span><span class="token punctuation">}</span>
 */
<span class="token function">getHttpPort</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token punctuation">{</span>
    address<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">;</span>
    port<span class="token punctuation">:</span> <span class="token keyword">number</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span><span class="token punctuation">;</span>
/**
 *
 * @param settings
 */
<span class="token function">setHttpPort</span><span class="token punctuation">(</span>settings<span class="token punctuation">:</span> <span class="token punctuation">{</span>
    address<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">;</span>
    port<span class="token punctuation">:</span> <span class="token keyword">number</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">void</span><span class="token punctuation">;</span>
/**
 *
 * @returns <span class="token punctuation">{</span><span class="token keyword">string</span>|<span class="token keyword">number</span><span class="token punctuation">}</span>
 */
<span class="token function">getHttpsPort</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token punctuation">{</span>
    address<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">;</span>
    port<span class="token punctuation">:</span> <span class="token keyword">number</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span><span class="token punctuation">;</span>
/**
 *
 * @param settings
 */
<span class="token function">setHttpsPort</span><span class="token punctuation">(</span>settings<span class="token punctuation">:</span> <span class="token punctuation">{</span>
    address<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">;</span>
    port<span class="token punctuation">:</span> <span class="token keyword">number</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">void</span><span class="token punctuation">;</span>
}

Description

ServerSettingsService contains all information about your Server configuration.

Members

get version(): string;

---

set version(v: string);

---

get rootDir(): string;

---

set rootDir(value: string);

---

get port(): string | number | false;

---

set port(value: string | number | false);

---

get httpsOptions(): Https.ServerOptions;

---

set httpsOptions(value: Https.ServerOptions);

---

get httpPort(): string | number | false;

---

set httpPort(value: string | number | false);

---

get httpsPort(): string | number | false;

---

set httpsPort(value: string | number | false);

---

get uploadDir(): string;

---

set uploadDir(value: string);

---

get env(): Env;

---

set env(value: Env);

---

get mount(): EndpointDirectoriesSettings;

---

set mount(value: EndpointDirectoriesSettings);

---

get componentsScan(): string[];

---

set componentsScan(value: string[]);

---

get statics(): EndpointDirectoriesSettings;

---

set statics(value: EndpointDirectoriesSettings);

---

get serveStatics(): EndpointDirectoriesSettings;

---

set serveStatics(value: EndpointDirectoriesSettings);

---

get acceptMimes(): string[];

---

set acceptMimes(value: string[]);

---

get debug(): boolean;

---

set debug(debug: boolean);

---

get validationModelStrict(): boolean;

---

set validationModelStrict(value: boolean);

---

get converter(): Partial<IConverterSettings>;

---

set converter(options: Partial<IConverterSettings>);

---

get logger(): Partial<PlatformLoggerSettings>;

---

set logger(value: Partial<PlatformLoggerSettings>);

---

get exclude(): string[];

---

set exclude(exclude: string[]);

---

get controllerScope(): ProviderScope;

---

set controllerScope(scope: ProviderScope);

---

get errors(): IErrorsSettings;

---

set errors(options: IErrorsSettings);

---

getHttpPort(): {
     address: string;
     port: number;
 };

---

setHttpPort(settings: {
     address: string;
     port: number;
 }): void;

---

getHttpsPort(): {
     address: string;
     port: number;
 };

---

setHttpsPort(settings: {
     address: string;
     port: number;
 }): void;