Interface UpstashRateLimitPort

Extended rate limit port interface that includes the Upstash Redis client. The Upstash provider adds the underlying client for advanced operations.

interface UpstashRateLimitPort {
client: Redis;
hit(options: RateLimitHitOptions): Promise<RateLimitResult>;
}

Hierarchy (View Summary)

RateLimitPort
- UpstashRateLimitPort

Index

Properties

Methods

Properties

client

client: Redis

The underlying Upstash Redis client instance. Use this for advanced operations not covered by the rate limit interface.

Methods

hit

hit(options: RateLimitHitOptions): Promise<RateLimitResult>
Record one hit for a rate-limit key and return the current decision.
Parameters
- options: RateLimitHitOptions
Returns Promise<RateLimitResult>
Inherited from RateLimitPort.hit
- Defined in core/dist/ports/rate-limit.d.ts:53