Install the package
What’s included
The package is built withtsup and ships three output formats:
| File | Format | Use case |
|---|---|---|
dist/index.js | CommonJS | Node.js / bundlers that require CJS |
dist/index.mjs | ESM | Modern bundlers (Vite, Next.js, etc.) |
dist/index.d.ts | TypeScript types | Full type-safety in TypeScript projects |
The package depends on
web-vitals for automatic LCP, INP, and CLS tracking. It is listed as a runtime dependency and installed automatically.Requirements
- Any modern browser or JavaScript runtime that supports
fetchandlocalStorage - TypeScript 5.0+ (optional, for type-safe configuration)
Next steps
Initialization
Initialize Iris in your app and start tracking pageviews.
Configuration
Full reference for all configuration options.