getEnv

workflow.getEnv() 读取当前 runtime 环境里的环境变量。它会 trim 变量名和变量值;变量名为空、变量不存在或变量值 trim 后为空时,返回 undefined

签名

workflow.getEnv(name: string): string | undefined

参数

参数类型说明
namestring环境变量名。会先 trim();空字符串直接返回 undefined

返回值

返回类型说明
环境变量值string变量存在且 trim 后非空时返回 trim 后的值。
未找到undefined变量名为空、变量不存在或变量值为空。

数据来源

运行位置来源说明
CLI / 本地 runtimeprocess.env 和 workflow .envexecutor 运行前会加载 workflow 目录下 .env
AppElectron 本地运行环境和本地项目配置App 只运行本地 dev 项目。
Serverserver 保存的环境变量和运行环境server web 保存的变量在运行时可读取。

读取流程

阶段输入结果
workflow 代码变量名workflow.getEnv(name)
runtime envprocess.env[name]trim 后的字符串或 undefined
provider / node字符串值用于 API key、base URL、模型名等配置

示例

const apiKey = workflow.getEnv("MY_API_KEY");

if (apiKey === undefined) {
  throw new workflow.WorkflowError({
    type: "input_validation",
    message: "Missing MY_API_KEY.",
  });
}

注意事项

规则说明
不返回空字符串值为 " " 时会返回 undefined
不负责默认值需要默认值时在业务代码中显式处理。
LLM provider 也依赖它createLLMProviderFromEnv() 会通过它读取 LLM_* 配置。