Class ConfigLoader

Exports for utils module

Index

Constructors

Methods

createDefault CreateDefault load Load save Save

Constructors

constructor

new ConfigLoader(): ConfigLoader
Returns ConfigLoader

Methods

`Static`createDefault

createDefault(): DBAutoDocConfig
Returns DBAutoDocConfig
Deprecated
Use CreateDefault.
- Defined in packages/DBAutoDoc/src/utils/config-loader.ts:136

`Static`CreateDefault

CreateDefault(): DBAutoDocConfig
Create default configuration

Returns DBAutoDocConfig
- Defined in packages/DBAutoDoc/src/utils/config-loader.ts:80

`Static`load

load(configPath: string): Promise<DBAutoDocConfig>
Parameters
- configPath: string
Returns Promise<DBAutoDocConfig>
Deprecated
Use Load.
- Defined in packages/DBAutoDoc/src/utils/config-loader.ts:39

`Static`Load

Load(configPath: string): Promise<DBAutoDocConfig>
Load configuration from file Supports environment variable expansion using ${ENV_VAR} syntax
Parameters
- configPath: string
Returns Promise<DBAutoDocConfig>
- Defined in packages/DBAutoDoc/src/utils/config-loader.ts:14

`Static`save

save(config: DBAutoDocConfig, configPath: string): Promise<void>
Parameters
- config: DBAutoDocConfig
- configPath: string
Returns Promise<void>
Deprecated
Use Save.
- Defined in packages/DBAutoDoc/src/utils/config-loader.ts:73

`Static`Save

Save(config: DBAutoDocConfig, configPath: string): Promise<void>
Save configuration to file
Parameters
- config: DBAutoDocConfig
- configPath: string
Returns Promise<void>
- Defined in packages/DBAutoDoc/src/utils/config-loader.ts:60