PlatformConfiguration

@tsed/platform-http

Usage

import { PlatformConfiguration } from "@tsed/platform-http";

See /packages/platform/platform-http/src/types/common/config/services/PlatformConfiguration.ts.

Overview

class PlatformConfiguration extends DIConfiguration {
    constructor();
    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 mount(): Record<string, TokenProvider[]>;
    set mount(value: Record<string, TokenProvider[]>);
    get statics(): Record<string, (any | string)[]>;
    set statics(value: Record<string, (any | string)[]>);
    get acceptMimes(): string[];
    set acceptMimes(value: string[]);
    get jsonMapper(): Partial<PlatformJsonMapperSettings>;
    set jsonMapper(options: Partial<PlatformJsonMapperSettings>);
    get additionalProperties(): boolean;
    getHttpPort(): ReturnType<typeof getHostInfoFromPort>;
    setHttpPort(settings: {
        address: string;
        port: number;
    }): void;
    getHttpsPort(): {
        protocol: string;
        address: string;
        port: number;
        toString(): string;
    };
    setHttpsPort(settings: {
        address: string;
        port: number;
    }): void;
    getBestHost(): {
        protocol: string;
        address: string;
        port: number;
        toString(): string;
    } | {
        toString(): string;
    };
}

Description

PlatformConfiguration contains all information about your Server configuration.

get port

get port(): string | number | false;

set port

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

get httpsOptions

get httpsOptions(): Https.ServerOptions;

set httpsOptions

set httpsOptions(value: Https.ServerOptions);

get httpPort

get httpPort(): string | number | false;

set httpPort

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

get httpsPort

get httpsPort(): string | number | false;

set httpsPort

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

get mount

get mount(): Record<string, TokenProvider[]>;

set mount

set mount(value: Record<string, TokenProvider[]>);

get statics

get statics(): Record<string, (any | string)[]>;

set statics

set statics(value: Record<string, (any | string)[]>);

get acceptMimes

get acceptMimes(): string[];

set acceptMimes

set acceptMimes(value: string[]);

get jsonMapper

get jsonMapper(): Partial<PlatformJsonMapperSettings>;

set jsonMapper

set jsonMapper(options: Partial<PlatformJsonMapperSettings>);

get additionalProperties

get additionalProperties(): boolean;

getHttpPort

getHttpPort(): ReturnType<typeof getHostInfoFromPort>;

setHttpPort

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

getHttpsPort

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

setHttpsPort

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

getBestHost

getBestHost(): {
     protocol: string;
     address: string;
     port: number;
     toString(): string;
 } | {
     toString(): string;
 };