configBound

Main ConfigBound class and configuration builder functions

Classes

Class	Description
ConfigBound	A ConfigBound is the top level object that contains all the Sections and Binds. It is used to retrieve the values of the Elements from its binds.
ConfigFileIsDirectoryException	An error that occurs when a config path is a directory instead of a file.
ConfigFileNotFoundException	An error that occurs when a config file cannot be found.
ConfigFileParseException	An error that occurs when a config file cannot be parsed or loaded.
ConfigLoaderException	Base exception class for configuration loading errors.
ExportNotFoundException	An error that occurs when a named export cannot be found in a config file.
InvalidConfigBoundInstanceException	An error that occurs when a config instance is not valid.
MissingDependencyException	An error that occurs when a dependency required by a config file is missing.
MultipleConfigBoundInstancesException	An error that occurs when multiple ConfigBound instances are found and none is specified.
NoConfigBoundInstancesException	An error that occurs when no ConfigBound instances are found in a config file.
TypedConfigBound	-

Type Aliases

Type Alias	Description
ConfigItem	Base schema type for individual config items
ConfigSchema	-
ConfigSection	Schema for nested sections
InferConfigType	-

Functions

Function	Description
configEnum	Helper for creating type-safe enum/union config items. Automatically handles the Zod type for string enums.
configItem	Creates a type-safe configuration item. This helper provides better type inference and makes the schema more readable.
configSection	Creates a configuration section with multiple related items. Sections help organize configuration into logical groups.

References

EnvVarBind

Re-exports EnvVarBind

---

FileBind

Re-exports FileBind

---

FileBindOptions

Re-exports FileBindOptions

---

FileFormat

Re-exports FileFormat

---

StaticBind

Re-exports StaticBind

---

StaticBindValues

Re-exports StaticBindValues