Skip to content

Reservation

Reservation = { granted: true; known?: boolean; resetAt?: number; } | { granted: false; reason?: "bucket" | "global" | "probe"; retryAfterMs: number; }

Defined in: packages/rest/src/store.ts:34

Outcome of an atomic reservation.

granted means one unit of the bucket’s allowance now belongs to the caller and to nobody else — the distinction that a read-then-write cannot make when several workers share a store. known says whether the bucket’s limit is known (so more requests may follow concurrently) or this request is the probe that discovers it; resetAt identifies the window the unit came from. A refusal says how long to wait and why.