Zod Config
Load configuration variables from multiple sources type safely using Zod.
Features
- 👮♂️ Type safety. Zod Config uses Zod;
- 🤌 Tiny. Zod Config is a tiny library with no dependencies, tree-shaking friendly;
- ✨ Flexible. Combine multiple adapters to load the configuration from different sources. We deeply merge the configuration from different sources, following the order of the adapters provided; Create your own adapters easily; Use the callback functions to handle errors and success due to the async nature of the adapters;
- 🪴 Easy to use. Zod Config is designed to be easy to use, with a simple API;
Install
npm install zod-config zod # npm
pnpm add zod-config zod # pnpm
yarn add zod-config zod # yarn(You need to install Zod as well, if you don't have it already)
Table of contents:
- Quick Start
- Default Adapter
- Built In Adapters
- Combine multiple adapters
- Callbacks
- Contributing notes
- On the web
Quick Start
Zod Config provides a loadConfig function that takes a Zod Object schema and returns a promise that resolves to the configuration object.
| Property | Type | Description | Required |
|---|---|---|---|
schema |
AnyZodObject |
A Zod Object schema to validate the configuration. | true |
adapters |
Adapter[] or Adapter |
Adapter(s) to load the configuration from. If not provided, process.env will be used. | false |
onError |
(error: Error) => void |
A callback to be called when an error occurs. | false |
onSuccess |
(config: z.infer ) => void |
A callback to be called when the configuration is loaded successfully. | false |
From the package we also expose the types Adapter and Config in case you want to use them in your own adapters.
This library provides some built in adapters to load the configuration from different sources via modules. You can easily import them from zod-config/<built-in-adapter-module-name> (see the examples below).
Default Adapter
By default, Zod Config will load the configuration from process.env, no need to provide any adapter.
import { z } from 'zod';
import { loadConfig } from 'zod-config';
const schemaConfig = z.object({
port: z.string().regex(/^\d+$/),
host: z.string(),
});
const config = await loadConfig({
schema: schemaConfig
});
// config is now type safe!
console.log(config.port)
console.log(config.host)Built In Adapters
Env Adapter
Loads the configuration from process.env or a custom object, allowing filtering the prefix keys to load.
import { z } from 'zod';
import { loadConfig } from 'zod-config';
import { envAdapter } from 'zod-config/env-adapter';
const schemaConfig = z.object({
port: z.string().regex(/^\d+$/),
host: z.string(),
});
// using default env (process.env)
const config = await loadConfig({
schema: schemaConfig,
adapters: envAdapter(),
});
// using custom env + filter prefix key
const customConfig = await loadConfig({
schema: schemaConfig,
adapters: envAdapter({
prefixKey: 'MY_APP_',
customEnv: {
MY_APP_PORT: '3000',
MY_APP_HOST: 'localhost',
IGNORED_KEY: 'ignored',
}
});JSON Adapter
Loads the configuration from a json file.
import { z } from 'zod';
import { loadConfig } from 'zod-config';
import { jsonAdapter } from 'zod-config/json-adapter';
const schemaConfig = z.object({
port: z.string().regex(/^\d+$/),
host: z.string(),
});
const filePath = path.join(__dirname, 'config.json');
const config = await loadConfig({
schema: schemaConfig,
adapters: jsonAdapter({ path: filePath }),
});
// using filter prefix key
const customConfig = await loadConfig({
schema: schemaConfig,
adapters: jsonAdapter({
path: filePath,
prefixKey: 'MY_APP_',
}),
});Dotenv Adapter
Loads the configuration from a .env file. In order to use this adapter, you need to install dotenv (peer dependency), if you don't have it already.
npm install dotenvimport { z } from 'zod';
import { loadConfig } from 'zod-config';
import { dotEnvAdapter } from 'zod-config/dotenv-adapter';
const schemaConfig = z.object({
port: z.string().regex(/^\d+$/),
host: z.string(),
});
const filePath = path.join(__dirname, '.env');
const config = await loadConfig({
schema: schemaConfig,
adapters: dotEnvAdapter({ path: filePath }),
});
// using filter prefix key
const customConfig = await loadConfig({
schema: schemaConfig,
adapters: dotEnvAdapter({
path: filePath,
prefixKey: 'MY_APP_',
}),
});Combine multiple adapters
You can combine multiple adapters to load the configuration from different sources. We deeply merge the configuration from different sources, following the order of the adapters provided.
import { z } from 'zod';
import { loadConfig } from 'zod-config';
import { envAdapter } from 'zod-config/env-adapter';
import { jsonAdapter } from 'zod-config/json-adapter';
const schemaConfig = z.object({
port: z.string().regex(/^\d+$/),
host: z.string(),
});
const filePath = path.join(__dirname, 'config.json');
const config = await loadConfig({
schema: schemaConfig,
adapters: [
jsonAdapter({ path: filePath }),
envAdapter(),
],
});Callbacks
You can use the callbacks to handle errors and success due to the async nature of the adapters.
import { z } from 'zod';
import { loadConfig } from 'zod-config';
loadConfig({
schema: schemaConfig,
onError: (error) => {
console.error('An error occurred while loading the configuration:', error);
},
onSuccess: (config) => {
console.log('Configuration loaded successfully:', config);
},
});Contributing notes
The goal is to have a helper to load configuration data from several srouces. If you have any source in mind, feel free to open a PR to add it or just open an issue to discuss it. More adapters are coming soon.
On the web
This library is referenced in the official Zod documentation as part of the ecosystem section "Powered by Zod", check it out here.