JavaScript SDK Overview

Installing the SDK

Install the SDK

Bun
pnpm
npm
Yarn

bun add limitem

pnpm add limitem

npm install limitem

yarn add limitem

Initialize the client

With API key
From env

import { limit } from "limitem";

const limiter = new limit.em({
  token: "limitem_sk_...",
  namespace: "my-app",
  limit: 100,
  duration: "1h",
});

import { limit } from "limitem";

// Reads LIMITEM_TOKEN or LIMITEM_KEY
const limiter = new limit.em({
  namespace: "my-app",
  limit: 100,
  duration: "1h",
});

Quick start

const result = await limiter.limit("user:123");

if (result.allowed) {
  // do the work
} else {
  // result.retry_after is set on 429s from the API
}

success is an alias of allowed. Older Contiguity code used success — both work.

Fail-open

If Limitem is down or the request times out (default 800ms), the SDK returns allowed: true and failover: true.

Pass fail_closed: true if you’d rather deny the request when Limitem is unreachable.

See limit.em for the full options list.

Getting Started

Algorithms

JavaScript SDK

JavaScript SDK Overview

Installing the SDK

Quick start

Fail-open

​Installing the SDK

​Quick start

​Fail-open

Installing the SDK

Quick start

Fail-open