@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.2 (2025-02-04)

🚀 New Features

• env: Support MODE environment variable for isDevelopment detection (#3012) (f3a45a7)
• Implement Astro integration (#2992) (a48eea8), closes #1075
• nestjs: Allow NestJS v11 as peerDependency (#3042) (4a75963), closes #2921
• redact: Pre-compile WebAssembly on module load (#3037) (c12bec5)

🪲 Bug Fixes

• analyze: Always lowercase headers and iterate in insertion order (#2865) (a9af1e4)
• arcjet: Ensure Characteristics are readonly type on protect signup options (#3013) (1f16a99)
• protocol: Double timeout when email rule configured (#2934) (23f9a9e), closes #1697

🧹 Miscellaneous Chores

• ci: Add dependabot for Astro example (#3068) (d4d8f82)
• ci: Avoid upgrading Tailwind where it breaks things (#3081) (5c25abe)
• ci: Restrict tailwind-merge where tailwind restricted (#3089) (a3437a5)
• docs: Add a link to the Redact reference page (#3038) (6095b6a)
• Refresh root & Next.js READMEs (#3066) (57a38d7)
• rollup-config: Consolidate wasmToModule plugin (#3039) (c3b8e36)