API Reference / @gtkx/config / @gtkx/config / LoadConfigOptions

Type Alias: LoadConfigOptions ​

LoadConfigOptions = object & Partial<Record<"configFile", string | undefined>>

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

How a configuration file is read, shared by loadConfig and createConfigLoader.

Type Declaration ​

defaultApplicationId? ​

optional defaultApplicationId?: string

Application ID for a project that is not an application, such as a component library running its tests: it stands in for a missing applicationId, and for a missing configuration file unless configFile names a file other than gtkx.config.ts in the project root.

mode? ​

optional mode?: string

Environment name such as development: the config's matching $<mode> block is layered over the top-level values, and the name is passed to a config authored as a function.

shouldWarnGraduatedFuture? ​

optional shouldWarnGraduatedFuture?: boolean

Whether to report graduated future flags; supervising processes can own these warnings. Defaults to true.