WaitKitWaitKit
JavaScript SDK

Installation & Configuration

Install the waitkit npm package and configure it for your project.

The JavaScript SDK is the primary integration path for Node.js and browser projects. It provides a typed client and an optional React hook.

Installation

npm install waitkit

The package ships ESM, CommonJS, and TypeScript declarations. No runtime dependencies other than fetch (available in Node.js 18+, browsers, Bun, and Deno).

Configuration

Create a WaitKit instance with your API key and project slug:

import { WaitKit } from "waitkit";

const wk = new WaitKit({
  apiKey: "wk_...",
  projectSlug: "my-project",
});

WaitKitConfig

ParamTypeDefaultDescription
apiKeystringAPI key from the dashboard
projectSlugstringSlug identifying the waitlist
baseUrlstringhttps://api.waitkit.devAPI base URL (self-hosted only)
sourcestringlanding-pageDefault source for all signups

Resources

The WaitKit instance exposes resources that map to API endpoints:

For React projects, see the React Hook.

On this page