InboundOptions

Defined in: src/inbound.ts:47

Properties

concurrency?

optional concurrency?: object

Defined in: src/inbound.ts:51

Max requests in flight; beyond queueLimit waiting requests, reject fast with 429/503 (load shedding).

permitLimit

permitLimit: number

queueLimit?

optional queueLimit?: number

queueTimeout?

optional queueTimeout?: Duration

---

pipeline?

optional pipeline?: ResiliencePipeline<any, any>

Defined in: src/inbound.ts:63

Bring your own pipeline instead (takes precedence).

---

rateLimit?

optional rateLimit?: object

Defined in: src/inbound.ts:56

Sliding-window rate limit, checked first; 429 beyond it. With key (it receives Express’s req or Hono’s c, e.g. (req) => req.ip) each key gets its own limit (at most maxPartitions keys kept, default 100 000); without it, one limit for all.

key?

optional key?: (req) => string

Parameters

req

any

Returns

string

maxPartitions?

optional maxPartitions?: number

permitLimit

permitLimit: number

segmentsPerWindow?

optional segmentsPerWindow?: number

window

window: Duration

---

rateLimitHeaders?

optional rateLimitHeaders?: false | "draft" | "legacy" | "both"

Defined in: src/inbound.ts:61

Headers sent when the pipeline has a rate limiter: 'draft' (default) IETF RateLimit-Limit/-Remaining/-Reset, 'legacy' X-RateLimit-*, 'both', or false. Reset is in seconds from now in both forms.

---

timeout?

optional timeout?: Duration

Defined in: src/inbound.ts:49

Budget per request. Everything called through a pipeline during the request inherits it (deadline propagation).