TypeScript SDK
The official client for Nervly is @nervly/sdk. It is typed against the same OpenAPI contract this reference is generated from, has zero runtime dependencies, and ships both ESM and CommonJS builds.
Current release: @nervly/sdk@0.1.1
npm install @nervly/sdk@0.1.1
import { Nervly } from '@nervly/sdk';
const nervly = new Nervly({ apiKey: process.env.NERVLY_API_KEY });
Compatibility
- Node.js 24 and later, plus any runtime with
fetchand WebCrypto (Deno, Bun, Cloudflare Workers, modern browsers). - TypeScript 5.4 and later for the bundled type definitions.
- Both
import(ESM) andrequire(CommonJS) are supported through package exports.
Stability
The SDK is currently 0.x, so the API is considered unstable until 1.0.0. Minor versions may refine the surface; breaking changes are documented in the SDK's CHANGELOG.md and announced with a deprecation window before removal.
Related
- Quickstart — install and send your first notification.
- API reference — the HTTP contract the SDK wraps.
- Authentication — API key and Test/Live modes.