ConfigFinderOptions <T>

Hierarchy

• BaseFinderOptions
  • ConfigFinderOptions

Index

Properties

• errorIfNoRootFound
• extendsSetting
• extensions
• includeEnv
• loaders
• name
• overridesSetting
• resolver

Properties

optionalerrorIfNoRootFound

errorIfNoRootFound?: boolean

Inherited from BaseFinderOptions.errorIfNoRootFound

Throw an error if the root config cannot be located.

optionalextendsSetting

extendsSetting?: string

Name of the setting in which "config extending" is enabled.

optionalextensions

extensions?: ExtType[]

List of extensions, in order, to find config files within each folder. Defaults to built-in file format list.

optionalincludeEnv

includeEnv?: boolean

Find and load environment based config files (using NODE_ENV). Defaults to true.

optionalloaders

loaders?: { cjs: Loader<T>; js: Loader<T>; json: Loader<T>; json5: Loader<T>; mjs: Loader<T>; ts: Loader<T>; yaml: Loader<T> }

Mapping of loader functions by type. Defaults to built-in file type loaders.

name

name: string

Inherited from BaseFinderOptions.name

Name of files, without extension.

optionaloverridesSetting

overridesSetting?: string

Name of the setting in which "config overriding" is enabled.

optionalresolver

resolver?: ModuleResolver

Custom module resolver.