@arcjet/analyze

@arcjet/analyze

Arcjet helps developers protect their apps in just a few lines of code. Implement rate limiting, bot protection, email verification, and defense against common attacks.

This is the Arcjet local analysis engine.

• npm package (@arcjet/analyze)
• GitHub source code (analyze/ in arcjet/arcjet-js)

What is this?

This package provides functionality to analyze requests. The work is done in WebAssembly but is called here from JavaScript. The functionality is wrapped up into rules in our core package (arcjet), in turn exposed from our adapters (such as @arcjet/next).

The WebAssembly files are in @arcjet/analyze-wasm. They are separate because we need to change the import structure for each runtime that we support in the bindings. Separate packages lets us not duplicate code while providing a combined higher-level API for calling our core functionality.

When should I use this?

This is an internal Arcjet package not designed for public use. See our Get started guide for how to use Arcjet in your application.

Install

This package is ESM only. Install with npm in Node.js:

npm install @arcjet/analyze

Use

import { generateFingerprint, isValidEmail } from "@arcjet/analyze";

const fingerprint = await generateFingerprint(
  { characteristics: [] },
  { ip: "127.0.0.1" },
);
console.log(fingerprint);
// => "fp::2::0d219da6100b99f95cf639b77e088c6df3c096aa5fd61dec5287c5cf94d5e545"

const result = await isValidEmail({}, "[e-mail]", {
  tag: "allow-email-validation-config",
  val: {
    allowDomainLiteral: false,
    allow: [],
    requireTopLevelDomain: true,
  },
});
console.log(result);
// => { blocked: [], validity: "valid" }

License

Apache License, Version 2.0 © Arcjet Labs, Inc.

Changelog

1.0.0-beta.10 (2025-08-04)

⚠ BREAKING CHANGES

• remove arbitrary base url from env in dev (#4755)

🪲 Bug Fixes

• ip: support readonly arrays, null, and exact optional props (#4695) (9c0b93a)
• remove arbitrary base url from env in dev (#4755) (49de60e)
• sveltekit: read from $env, not process.env (#4754) (5a87f0d)

📝 Documentation

• add uniform install section to readmes (#4633) (709ff1e)
• add uniform license section to readmes (#4634) (af1c322)
• add uniform use section to readmes (#4655) (ac27256)
• fastify: mention quick start example in readme (#4724) (5df48d8)

🧹 Miscellaneous Chores

• bindings: regenerate WebAssembly bindings (#4600) (4377b20)
• fix unused import in tests (#4588) (1a9bdb1)

⌨️ Code Refactoring

• sort packages in release please config (#4589) (80ef9eb)
• tsconfig: clean base config (#4590) (160ff98)

📚 Tests

• add tests for public interface (#4587) (f7aabec)
• add tests for unsupported headers per platform (#4694) (8de2603)
• clean ip tests (#4632) (aea416a)

🔨 Build System

• examples: add bun, deno examples (#4693) (4e73f95)
• examples: add missing examples (#4721) (4cffef9)
• examples: add strict type checking (#4666) (7b3f4d0)
• examples: simplify reusable examples (#4692) (ef12202)

✅ Continuous Integration

• add githubusercontent to examples (#4598) (1109272)