当前位置：文江博客 Node Package Readme config 中文文档教程

config 中文文档教程

发布于 3年前浏览 2 项目主页更新于 3年前

Configure your Node.js Applications

发行说明

Introduction

Node-config 为您的应用程序部署组织分层配置。

它允许您定义一组默认参数，并针对不同的部署环境（开发、质量保证、演出、制作等）。

配置存储在应用程序的配置文件中，并且可以通过环境变量, 命令行参数，或者外部资源。

这为您的应用程序提供了一个在不断增长的 npm 模块列表也使用节点配置。

Project Guidelines

Simple - Get started fast
Powerful - For multi-node enterprise deployment
Flexible - Supporting multiple config file formats
Lightweight - Small file and memory footprint
Predictable - Well tested foundation for module and app developers

Quick Start

以下示例是 JSON 格式，但配置可以是其他文件格式 .

在您的应用程序目录中安装，并编辑默认配置文件。

$ npm install config
$ mkdir config
$ vi config/default.json

{
  // Customer module configs
  "Customer": {
    "dbConfig": {
      "host": "localhost",
      "port": 5984,
      "dbName": "customers"
    },
    "credit": {
      "initialLimit": 100,
      // Set low for development
      "initialDays": 1
    }
  }
}

为生产部署编辑配置覆盖：

 $ vi config/production.json

{
  "Customer": {
    "dbConfig": {
      "host": "prod-db-server"
    },
    "credit": {
      "initialDays": 30
    }
  }
}

在您的代码中使用配置：

const config = require('config');
//...
const dbConfig = config.get('Customer.dbConfig');
db.connect(dbConfig, ...);

if (config.has('optionalFeature.detail')) {
  const detail = config.get('optionalFeature.detail');
  //...
}

config.get() 将为未定义的键抛出异常，以帮助捕获拼写错误和缺失值。使用 config.has() 测试是否定义了配置值。

启动您的应用服务器：

$ export NODE_ENV=production
$ node my-app.js

在此配置中运行，dbConfig 的port 和dbName 元素将来自 default.json 文件，host 元素将来自 production.json 覆盖文件。

Articles

Further Information

如果你仍然没有看到你要找的东西，这里有一些更多的资源可以检查：

The wiki may have more pages which are not directly linked from here.
Review questions tagged with node-config on StackExchange. These are monitored by node-config contributors.
Search the issue tracker. Hundreds of issues have already been discussed and resolved there.

Contributors

License

可以在麻省理工学院许可证。

原文

Configure your Node.js Applications

release notes

Introduction

Node-config organizes hierarchical configurations for your app deployments.

It lets you define a set of default parameters, and extend them for different deployment environments (development, qa, staging, production, etc.).

Configurations are stored in configuration files within your application, and can be overridden and extended by environment variables, command line parameters, or external sources.

This gives your application a consistent configuration interface shared among a growing list of npm modules also using node-config.

Project Guidelines

Simple - Get started fast
Powerful - For multi-node enterprise deployment
Flexible - Supporting multiple config file formats
Lightweight - Small file and memory footprint
Predictable - Well tested foundation for module and app developers

Quick Start

The following examples are in JSON format, but configurations can be in other file formats.

Install in your app directory, and edit the default config file.

$ npm install config
$ mkdir config
$ vi config/default.json

{
  // Customer module configs
  "Customer": {
    "dbConfig": {
      "host": "localhost",
      "port": 5984,
      "dbName": "customers"
    },
    "credit": {
      "initialLimit": 100,
      // Set low for development
      "initialDays": 1
    }
  }
}

Edit config overrides for production deployment:

 $ vi config/production.json

{
  "Customer": {
    "dbConfig": {
      "host": "prod-db-server"
    },
    "credit": {
      "initialDays": 30
    }
  }
}

Use configs in your code:

const config = require('config');
//...
const dbConfig = config.get('Customer.dbConfig');
db.connect(dbConfig, ...);

if (config.has('optionalFeature.detail')) {
  const detail = config.get('optionalFeature.detail');
  //...
}

config.get() will throw an exception for undefined keys to help catch typos and missing values. Use config.has() to test if a configuration value is defined.

Start your app server:

$ export NODE_ENV=production
$ node my-app.js

Running in this configuration, the port and dbName elements of dbConfig will come from the default.json file, and the host element will come from the production.json override file.

Articles

Further Information

If you still don't see what you are looking for, here are some more resources to check:

The wiki may have more pages which are not directly linked from here.
Review questions tagged with node-config on StackExchange. These are monitored by node-config contributors.
Search the issue tracker. Hundreds of issues have already been discussed and resolved there.

Contributors

License

May be freely distributed under the MIT license.

友情链接

文江博客

lorenwest	markstos	iMoses	elliotttf	jfelege	leachiM2k
josx	enyo	leosuncin	arthanzel	eheikes	th507
Osterjour	cunneen	nsabovic	BadgerBadgerBadgerBadger	simon-scherzinger	leonardovillela
axelhzf	benkroeger	fgheorghe	IvanVergiliev	jpwilliams	jaylynch
jberrisch	kgoerlitz	bertho-zero	NguyenMatthieu	nitzan-shaked	robertrossmann

lorenwest	markstos	iMoses	elliotttf	jfelege	leachiM2k
josx	enyo	leosuncin	arthanzel	eheikes	th507
Osterjour	cunneen	nsabovic	BadgerBadgerBadgerBadger	simon-scherzinger	leonardovillela
axelhzf	benkroeger	fgheorghe	IvanVergiliev	jpwilliams	jaylynch
jberrisch	kgoerlitz	bertho-zero	NguyenMatthieu	nitzan-shaked	robertrossmann

config 中文文档教程

Configure your Node.js Applications

Introduction

Project Guidelines

Quick Start

Articles

Further Information

Contributors

License

Configure your Node.js Applications

Introduction

Project Guidelines

Quick Start

Articles

Further Information

Contributors

License

你可能也喜欢

友情链接