@ golevelup/ 配置
关于
探测器目前建在岩石上 Mozilla的定罪配置库它能帮助你 12 符合 应用程序配置,将焦点放在以安全的方式利用环境变量,同时允许您从.env和.json文件中加载配置,以便在开发过程中方便.
特征
- 从.env文件或json文件自动装入配置,并带有等级上覆
- 轻松控制哪个配置文件根据您的节点环境加载
- 为支持不同类型认证而建造
- 智能和类型安全
- 简单的测试工具, 当您想要嘲笑您的配置时
使用量
安装
npm install ---save @golevelup/profiguration
或者说
yarn add @golevelup/profiguration
定义一个代表您预测的界面
界面应代表您想要访问您的应用程序配置的对象结构 。 它可以是一个复杂的物体,有嵌入值和不同类型
例如:
interface Config {
db: {
password: string;
host: {
url: string;
port: number;
};
};
appPort: number;
globalPrefix: string;
controllerPrefix: string;
showWelcomeMessage: boolean;
}
创建计算实例
这个 createProfiguration 工厂方法需要一种计划,表明您配置接口的各种属性应该如何从进程环境中加载。 见 定罪证件 用于补充选项和文件.
第二个参数配置了用于记录、验证和相对文件加载路径的选项以及用户提供的功能 configureEnv 允许每个环境压倒配置选项以及应加载包含配置值的文件.
import { createProfiguration } from '@golevelup/profiguration';
export const config = createProfiguration<Config>(
{
appPort: {
default: 3333,
env: 'APP_PORT'
},
db: {
password: {
default: null,
format: String,
env: 'DB_PASSWORD'
},
host: {
url: {
default: '',
env: 'DB_HOST_URL'
},
port: {
default: -1,
format: 'port',
env: 'DB_HOST_PORT'
}
}
},
globalPrefix: {
default: 'api',
env: 'GLOBAL_PREFIX'
},
controllerPrefix: {
default: '',
env: 'CONTROLLER_PREFIX'
},
showWelcomeMessage: {
default: true,
env: 'WELCOME_MESSAGE'
}
},
{
strict: true,
verbose: true,
loadRelativeTo: 'parent-module',
configureEnv: env => ({
files: `${env}.env`
})
}
);