UNPKG

@calf/helios

Version:

Helios module of Calf framework.

95 lines (94 loc) 2.23 kB
import { IHeliosConfig } from "../interfaces/configs/config.interface"; /** * Helios config * @description Helios configuration service */ export declare class HeliosConfig { /** * Host * @description Helios host */ static get host(): string; /** * Host path * @description Helios path from host */ static get hostPath(): string; /** * Port * @description Helios port */ static get port(): number; /** * Version * @description API version */ static get version(): string; /** * Default request method * @description Get default request method */ static get defaultRequestMethod(): string; /** * Default custom headers */ static get defaultCustomHeaders(): { [key: string]: string; }; /** * SSL * @description Whether to use SSL * connection */ static get ssl(): boolean; /** * Debug * @description Whether to debug */ static get debug(): boolean; /** * Runtime timeout * @description Timeout of runtime in ms */ static get runtimeTimeout(): number; /** * Delay between requests * @description Delay between requests in ms */ static get delayBetweenRequests(): number; /** * Browse response limit * @description Maximum browse response iterations */ static get browseResponseLimit(): number; /** * Instance * @description Configuration instance */ private static _instance; private _host; private _hostPath; private _port; private _defaultRequestMethod; private _defaultCustomHeaders; private _version; private _ssl; private _runtimeTimeout; private _debug; private _delayBetweenRequests; private _browseResponseLimit; /** * Constructor * @param config */ private constructor(); /** * Initialize config * @param config */ static initialize(config: IHeliosConfig): void; /** * Ensure initialization */ static ensureInitialization(): void; }