@detent/sdk

@detent/sdk

Typed TypeScript client for the Detent rate-limiting API.

Status: pre-1.0 — the API may change between minor versions until 1.0.0.

Install

npm i @detent/sdk

Usage

import { Detent } from '@detent/sdk'

const rg = new Detent({ apiKey: process.env.DETENT_API_KEY! })

// Rate-limit check (always resolves; fails open by default on transport error)
const { allowed } = await rg.limit({ namespace: 'api', key: userId })
if (!allowed) return res.status(429).end()

// Concurrent-limit lease
await rg.withLease({ namespace: 'jobs', key: userId }, async () => {
  await runExpensiveJob()
})

// Read-only usage stats
const stats = await rg.getStats({ namespace: 'api' })

Configuration

limit() never throws on a transport error or a 5xx server error — it returns { degraded: true } and respects failMode. Only 4xx client errors (bad key, plan gate, unknown rule, malformed request) throw DetentApiError.