TypeScript SDKFeature Clients
RatelimitsTypeScript SDK
Ratelimits Client
The rate limits client is a wrapper for Hatchet’s gRPC API that makes it easier to work with rate limits in Hatchet.
Methods
list()
Lists all rate limits for the current tenant.
Parameters
| Parameter | Type | Description |
|---|---|---|
opts | | { limit?: number; offset?: number; orderByDirection?: RateLimitOrderByDirection; orderByField?: RateLimitOrderByField; search?: string; } | undefined | The options for the list operation. |
Returns
Promise<RateLimitList>
A promise that resolves to the list of rate limits.
pause()
Pauses a rate limit key, so queued runs that consume it stay queued until until.
Parameters
| Parameter | Type | Description |
|---|---|---|
opts | PauseRateLimitOpts | The key and the time to pause it until. |
Returns
Promise<Date>
A promise that resolves to the time the key is paused until.
upsert()
Upserts a rate limit for the current tenant.
Parameters
| Parameter | Type | Description |
|---|---|---|
opts | CreateRateLimitOpts | The options for the upsert operation. |
Returns
Promise<string>
A promise that resolves to the key of the upserted rate limit.
Last updated on October 23, 2026