内存2doc

此工具帮助您跟踪所有使用的环境变量—— 如果访问通过 @fluidware-it/saddleback EnvParse 函数.

使用量

它可以通过 npx

npx @fluidware-it/env2doc -p /path/to/javascript/files

或可以在全球安装,然后使用

npm i -g @fluidware-it/env2doc

env2doc -p /path/to/javascript/files

默认情况下,它以Markdown格式输出。 使用 -o json 以 JSON 格式输出的参数

实例

node @fluidware-it/env2doc -p ~/Projects/fluidware/express-microservice/build/src

## Environment variables

| ENV                           |     type |                        default | required |
| ----------------------------- | -------- | ------------------------------ | -------- |
| FW_MS_PRE_SHARED_TOKEN_PREFIX |   string |                                |          |
| FW_MS_PORT                    |  integer |                           8080 |          |
| FW_MS_LOG_404                 |  boolean |                          false |          |
| FW_MS_HOSTNAME                |   string |          default to hostname() |          |
| FW_MS_ADDRESS                 |   string |                                |          |
| FW_MS_ADDRESSES               | string[] |                                |          |
| FW_MS_TRUST_PROXY             | string[] | loopback,linklocal,uniquelocal |          |
| FW_MS_MAX_UPLOAD_SIZE         |   string |                          128kb |          |
| FW_MS_JWT_PUBLIC_KEY          |   string |                                |          |
| FW_MS_KEY                     |   string |                                |          |
| FW_MS_CERT                    |   string |                                |          |