@6thquake/react-properties 中文文档教程
react-properties
Installation
这个模块通过 npm 分发,源代码也可以在 github.com 上找到。
npm
$ npm install @6thquake/react-properties
yarn
$ yarn add @6thquake/react-properties
Documentation
该模块添加了对与以下各项相对应的配置文件的内置支持:.env.development、.env.test 和 .env.production。 这些文件中的值比 .env 中的值具有更高的优先级。 每个文件(包括默认文件)都通过在末尾添加 .local 来支持另一层覆盖。 完整的优先顺序是(最高优先):
.env.{environment}.local
.env.{environment}
.env.local
.env
local.json
package.json
前 4 个隐藏文件遵循 Java .properties 规范的 ini 部分;
请查看我们的文档网站了解更多信息。
Examples
- if you have a configuration file named .env.development:
HTTPS=false
PORT=8080
[proxy]
/api.target=/
/api.headers={}
/api.changeOrigin=true
/api.secure=false
/api.proxyTimeout=6000
/websocket.target=/
/websocket.headers={}
/websocket.changeOrigin=true
/websocket.secure=false
/websocket.ws=true
- .env file also supported at the root path of you project:
PORT=8888
- and the package.json is:
{
"name": "test",
"dependencies": {
"react-properties": "^0.1.0"
}
}
在您的节点项目中:
const Properties = require('@6thquake/react-properties');
const properties = Properties.load(process.pwd());
如果您使用“NODE_ENV=development”运行,所有配置参数将为:
{
"HTTPS": false,
"PORT": 8888,
"name": "test",
"dependencies": {
"react-properties": "^0.1.0"
}
"proxy":{
"/api": {
"target": "/",
"headers": {},
"changeOrigin": true,
"secure": false,
"proxyTimeout": 6000
},
"/websocket": {
"target": "/",
"headers": {},
"changeOrigin": true,
"secure": false,
"ws": true
}
}
}
Contributing
我们将非常感谢您所做的任何贡献。)
Changelog
最近更新? 请阅读变更日志。
Roadmap
可以在 ROADMAP.md 文件中找到未来计划和高优先级功能和增强功能。
License
该项目根据以下条款获得许可 麻省理工学院许可证。
react-properties
Installation
This module is distributed via npm, and the source code is available on github.com too.
npm
$ npm install @6thquake/react-properties
yarn
$ yarn add @6thquake/react-properties
Documentation
This module adds built-in support for a configuration file corresponding to each of these: .env.development, .env.test, and .env.production. The values from these files have higher priority than the values in .env. Each file (including the default file) supports another layer of overrides by adding .local to the end. The full order of precedence is (highest first):
.env.{environment}.local
.env.{environment}
.env.local
.env
local.json
package.json
Those top 4 hidden files follows Java .properties specification, ini sections;
Please Check out our documentation website for more information.
Examples
- if you have a configuration file named .env.development:
HTTPS=false
PORT=8080
[proxy]
/api.target=/
/api.headers={}
/api.changeOrigin=true
/api.secure=false
/api.proxyTimeout=6000
/websocket.target=/
/websocket.headers={}
/websocket.changeOrigin=true
/websocket.secure=false
/websocket.ws=true
- .env file also supported at the root path of you project:
PORT=8888
- and the package.json is:
{
"name": "test",
"dependencies": {
"react-properties": "^0.1.0"
}
}
in your node project:
const Properties = require('@6thquake/react-properties');
const properties = Properties.load(process.pwd());
if you run with "NODE_ENV=development", all the configuration parameters will be:
{
"HTTPS": false,
"PORT": 8888,
"name": "test",
"dependencies": {
"react-properties": "^0.1.0"
}
"proxy":{
"/api": {
"target": "/",
"headers": {},
"changeOrigin": true,
"secure": false,
"proxyTimeout": 6000
},
"/websocket": {
"target": "/",
"headers": {},
"changeOrigin": true,
"secure": false,
"ws": true
}
}
}
Contributing
We'd greatly appreciate any contribution you make.)
Changelog
Recently Updated? Please read the changelog.
Roadmap
The future plans and high priority features and enhancements can be found in the ROADMAP.md file.
License
This project is licensed under the terms of the MIT license.