Configuration

The Keyset constructor accepts a single KeysetConfig object.

TypeScriptCopy
import { Keyset } from "keysetapp";

const client = new Keyset(config: KeysetConfig);

KeysetConfig

CacheConfig

Examples

Minimal (public, no cache)

TypeScriptCopy
const client = new Keyset({
  apiKey: "pkey_abc123",
  cacheTTL: 0,
});

With caching and retry

TypeScriptCopy
const client = new Keyset({
  apiKey: "pkey_abc123",
  cacheTTL: 60000,
  cache: {
    enabled: true,
    ttl: 60000, // cache responses for 60 seconds
  },
  retries: 3,
  timeout: 8000,
});

With a custom base URL

TypeScriptCopy
const client = new Keyset({
  apiKey: "pkey_abc123",
  cacheTTL: 0,
  baseUrl: "https://keyset.mycompany.com/api/v1",
});

Secret key (server-side)

TypeScriptCopy
const admin = new Keyset({
  apiKey: "skey_xyz789",
  cacheTTL: 0,
  retries: 2,
});

API key validation

The SDK validates the key format at construction time. Invalid keys throw immediately:

TypeScriptCopy
new Keyset({ apiKey: "", cacheTTL: 0 });
// Error: API key is required

new Keyset({ apiKey: "invalid_key", cacheTTL: 0 });
// Error: Invalid API key format

Valid prefixes are pkey_ (public) and skey_ (secret).

Cache internals

When cache.enabled is true, the SDK creates an in-memory MemoryCache instance with:

• TTL — entries expire after cache.ttl milliseconds (default 60 000 ms)
• Max size — 1 000 entries maximum; when full, the oldest entry is evicted (LRU-ish)
• Garbage collection — expired entries are purged every 60 seconds automatically
• Cache invalidation — write operations (create, update, delete) automatically delete the cached content response