GTKX

API Reference / @gtkx/config / index / loadConfig

Function: loadConfig() ​

loadConfig(cwd, options?): Promise<LoadedConfig>

Defined in: packages/config/src/loader.ts:108

Loads and validates the gtkx.config.ts file for a project.

Parameters ​

cwd ​

string

Directory the configuration file is looked up in; parent directories are not searched.

options? ​

LoadConfigOptions = {}

Loading options, such as the environment mode whose overrides are applied.

Returns ​

Promise<LoadedConfig>

Throws ​

When that directory holds no configuration file, or when the configuration fails validation.