環境変数 - Square Cloud

app.envs は EnvsModule を公開しており、アプリケーションが実行時に参照する KEY=value のペアを管理できます。

const app = await api.applications.fetch("abc123def456abc123def456");
app.envs; // EnvsModule

すべてのメソッドは、操作完了後の環境変数一式へと解決されます。そのため常に最新の { key: value } マップが返されます。

環境変数の一覧取得

const envs = await app.envs.list();

console.log(envs);
// { DATABASE_URL: "postgres://...", FEATURE_FLAG: "true" }

app.envs.set(envs) は新しい変数を既存の一式にマージします。呼び出しに含まれていない既存のキーは保持されます。

await app.envs.set({
    DATABASE_URL: "postgres://...",
    FEATURE_FLAG: "true",
});

app.envs.replace(envs) はすべての変数を上書きします。リストに含まれていないものは削除されます。

await app.envs.replace({
    DATABASE_URL: "postgres://new-host...",
});
// FEATURE_FLAG is now gone

すべての変数を消去するには空のオブジェクトを渡します。

await app.envs.replace({});

app.envs.delete(keys) はリストに指定したキーを削除します。存在しないキーは静かに無視されます。

await app.envs.delete(["FEATURE_FLAG"]);