📜  lanord 定义 (1)

📅  最后修改于: 2023-12-03 14:43:43.898000             🧑  作者: Mango

Lanord 定义

Lanord 是一种开源的配置库形式,旨在提供一个方便和可靠的方式来管理您的应用程序的配置信息。 它允许您将配置存储在各种数据源中(例如 JSON,YAML,INI 或环境变量),并将其加载到应用程序中。

特征
  • 支持多种配置数据源
  • 可以使用多个配置文件
  • 简单易用的 API
  • 支持动态修改配置
  • 支持配置热加载
安装

您可以通过以下方式安装 Lanord:

npm install lanord --save
用法
定义配置文件格式

Lanord 支持以下格式的配置文件:

  • JSON
  • YAML
  • INI

您可以简单地将配置文件作为对象导出。

JSON

{
  "port": 3000,
  "database": {
    "name": "test",
    "host": "localhost",
    "port": 27017
  }
}

YAML

port: 3000
database:
  name: test
  host: localhost
  port: 27017

INI

port = 3000
[database]
name = test
host = localhost
port = 27017
加载配置
const lanord = require('lanord');
const config = lanord.load({
  files: ['config.json', 'config.yaml'],
  cwd: __dirname,
  env: 'production'
});
  • files:一个字符串或字符串数组,用于指定要加载的配置文件的名称或路径。如果是相对路径,cwd 选项将用于解析它们。省略文件扩展名时,将按以下顺序查找文件:.js.json.yaml.yml.ini
  • cwd:一个字符串,表示用于解析相对路径的当前工作目录。默认值是应用程序的根目录。
  • env:一个字符串,表示要加载的配置环境。如果未指定,则默认为“development”。
获取配置项
const port = config.get('port');
const dbName = config.get('database.name');
动态修改配置
config.set('port', 4000);
监听配置变化
config.on('change', (key, value) => {
  console.log(`Config "${key}" has been changed to "${value}".`);
});
卸载配置
config.unload();
结论

Lanord 是一个非常实用的 Node.js 配置库,它可以轻松地管理您的应用程序的配置信息。它支持多个配置数据源、多个配置文件、动态修改配置和配置热加载。它的 API 简单易用,让您可以更加专注于编写业务代码。