@arcjet/env

@arcjet/env

Arcjet environment detection.

Currently operates on an environment object with the type:

type Env = {
  FLY_APP_NAME?: string;
  NODE_ENV?: string;
  ARCJET_KEY?: string;
  ARCJET_ENV?: string;
  ARCJET_LOG_LEVEL?: string;
  ARCJET_BASE_URL?: string;
};

Installation

npm install -S @arcjet/env

Example

import * as env from "@arcjet/env";

env.platform({ FLY_APP_NAME: "foobar" }) === "fly-io";
env.platform({}) === undefined;

env.isDevelopment({ NODE_ENV: "production" }) === false;
env.isDevelopment({ NODE_ENV: "development" }) === true;
env.isDevelopment({ ARCJET_ENV: "production" }) === false;
env.isDevelopment({ ARCJET_ENV: "development" }) === true;

env.logLevel({ ARCJET_LOG_LEVEL: "debug" }) === "debug";
env.logLevel({ ARCJET_LOG_LEVEL: "info" }) === "info";
env.logLevel({ ARCJET_LOG_LEVEL: "warn" }) === "warn";
env.logLevel({ ARCJET_LOG_LEVEL: "error" }) === "error";
env.logLevel({ ARCJET_LOG_LEVEL: "" }) === "warn"; // default

// Will use various environment variables to detect the proper base URL
env.baseUrl(process.env);

env.apiKey({ ARCJET_KEY: "ajkey_abc123" }) === "ajkey_abc123";
env.apiKey({ ARCJET_KEY: "invalid" }) === undefined;

License

Licensed under the Apache License, Version 2.0.

Changelog

1.0.0-beta.7 (2025-05-06)

🚀 New Features

• protocol: Support identifier and version on rules (#4027) (37cd996)

🪲 Bug Fixes

• arcjet-node: Ensure process.env.RENDER is surfaced (#3969) (18f7383), closes #3899
• protocol: Ensure sensitiveInfo rule sends mode (#4026) (3ce22ed)

🧹 Miscellaneous Chores

• Add note about signed commits (#3958) (c76ae28)
• ci: Add permissions to each job (#3976) (ce55cd7)
• Document devcontainer setup (cf0ccd6)
• protocol: Increase code coverage on ArcjetStackToProtocol (#4025) (6d89564)