As33
@periodic/
arsenic

Installation

Install the core package. Everything else is optional — install only what your stack needs.

Core package

bash
npm install @periodic/arsenic
bash
yarn add @periodic/arsenic

Peer dependencies

Arsenic has zero required dependencies. Install only the peer deps that match your stack:

Database adapters

bash
# MongoDB via Mongoose
npm install mongoose

# SQL via Prisma
npm install @prisma/client

# PostgreSQL raw driver
npm install pg

# Redis (either client works)
npm install redis
npm install ioredis

Framework support

bash
npm install express   # For Express
npm install fastify   # For Fastify

Exporters

bash
npm install @opentelemetry/api  # For OpenTelemetry

Peer dependency table

PackageUsed forRequired?
mongooseMongoDB via Mongoose adapterNo — only with Mongoose
@prisma/clientSQL databases via Prisma adapterNo — only with Prisma
pgPostgreSQL via raw pg adapterNo — only with pg
ioredis / redisRedis adapterNo — only with Redis
expressExpress request contextNo — only with Express
fastifyFastify request contextNo — only with Fastify
@opentelemetry/apiOpenTelemetry exporterNo — only if using OTEL

Requirements

  • Node.js ≥ 16.0.0 (AsyncLocalStorage support)
  • TypeScript ≥ 4.5.0 (if using TypeScript)
  • npm ≥ 7.0.0

TypeScript support included

Full TypeScript types are bundled. No @types/ package needed. Strict mode compatible.