Class NanoConfig<Data>

Type parameters

Data: NanoConfigData

Hierarchy

NanoConfig
- NanoConfigTemplate

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new NanoConfig(options: NanoConfigOptions<Data>): NanoConfig

- Defined in NanoConfig.ts:33
Parameters
- options: NanoConfigOptions<Data>
Returns NanoConfig

Properties

Protected convict

convict: Config<Data>

logger

logger: LoggerInstance

options

options: NanoConfigOptions<Data>

Protected storage

storage: NanoConfigStorage

Methods

dump

dump(overrideName?: string, overridePath?: string): Promise<void>

- Defined in NanoConfig.ts:97
Parameters
- Optional overrideName: string
- Optional overridePath: string
Returns Promise<void>

get

get(key?: string): Data

- Defined in NanoConfig.ts:83
Parameters
- Optional key: string
Returns Data

loadSync

loadSync(): void

- Defined in NanoConfig.ts:93
Returns void

set

set<Type>(key: string, data: Type): void

- Defined in NanoConfig.ts:88
Type parameters
- Type
Parameters
- key: string
- data: Type
Returns void

Static environment

environment<Data>(options: NanoConfigOptions<Data> & NanoEnvFile): NanoConfig<Data>

- Defined in NanoConfig.ts:57
Type parameters
- Data: NanoConfigData
Parameters
- options: NanoConfigOptions<Data> & NanoEnvFile
Returns NanoConfig<Data>

Generated using TypeDoc