@arcjet/env
弧喷 环境探测.
这是什么?
这是用于读取配置的工具 process.env 财务报告和审定财务报表
类似.
它的存在是为了我们能够在整个包中访问这种配置.
我什么时候用这个?
你也许不该用这个 但是有些边缘的案子我们让 用户将更先进的功能互换出去,然后可能有用.
安装
这套方案只是无害环境管理. 在 Node.js 用 npm 安装 :
npm install @arcjet/env
使用
import process from "node:process";
import { baseUrl, isDevelopment, logLevel, platform } from "@arcjet/env";
console.log(platform({ FLY_APP_NAME: "foobar" })); // => "fly-io"
console.log(platform({})); // => undefined
console.log(isDevelopment({ NODE_ENV: "production" })); // => false
console.log(isDevelopment({ NODE_ENV: "development" })); // => true
console.log(isDevelopment({ ARCJET_ENV: "production" })); // => false
console.log(isDevelopment({ ARCJET_ENV: "development" })); // => true
console.log(logLevel({ ARCJET_LOG_LEVEL: "debug" })); // => "debug"
console.log(logLevel({ ARCJET_LOG_LEVEL: "info" })); // => "info"
console.log(logLevel({ ARCJET_LOG_LEVEL: "warn" })); // => "warn"
console.log(logLevel({ ARCJET_LOG_LEVEL: "error" })); // => "error"
console.log(logLevel({ ARCJET_LOG_LEVEL: "" })); // => "warn"
console.log(baseUrl(process.env)); // => "https://decide.arcjet.com"
API 密码
此软件包导出标识符
baseUrl, (中文(简体) ),
isDevelopment, (中文(简体) ),
logLevel,以及
platform。 。 。 .
没有默认导出 .
此套件导出 类型脚本 类型
Env 财务报告和审定财务报表
Platform。 。 。 .
Env
此类型代表您在 这个包裹。 它包括已知的Arcjet和平台特定环境 变量.
类型
export type Env = {
[key: string]: unknown;
ARCJET_BASE_URL?: string | undefined;
ARCJET_ENV?: string | undefined;
ARCJET_LOG_LEVEL?: string | undefined;
FIREBASE_CONFIG?: string | undefined;
FLY_APP_NAME?: string | undefined;
MODE?: string | undefined;
NODE_ENV?: string | undefined;
RENDER?: string | undefined;
VERCEL?: string | undefined;
};
Platform
该类型代表了能够被检测到的平台名称.
类型
type Platform = "firebase" | "fly-io" | "render" | "vercel";
baseUrl(environment)
返回Arcjet API的基础 URL。 需要的话可以使用 知道Arcjet会和哪个API终点说话.
参数
environment(单位:千美元)Env(中文(简体) ) - 环境物体,一般process.env
回返
Arcjet API 的基础 URL (string) (中文(简体) ).
isDevelopment(environment)
检查当前环境是否为开发环境. 我们用 以调整发展与生产之间的行为.
参数
environment(单位:千美元)Env(中文(简体) ) - 环境物体,一般process.env
回返
环境是否是发展(boolean) (中文(简体) ).
logLevel(environment)
从环境返回已配置的日志级别 。 如果没有日志级别
设置,默认为 "warn"。 。 。 .
参数
environment(单位:千美元)Env(中文(简体) ) - 环境物体,一般process.env
回返
日志级别 ("debug" | "error" | "info" | "warn") (中文(简体) ).
platform(environment)
检测您的代码基于环境运行的平台 变量.
参数
environment(单位:千美元)Env(中文(简体) ) - 环境物体,一般process.env
回返
如果找到平台名称( N)Platform),或 undefined
否则.