RateLimitResult interface

Package:

@microsoft/agents-hosting

Details about a rate limit decision.

Properties

key	The derived rate limit key.
retryAfterMs	Approximate delay before another activity would be accepted. For fixed-window limits, this is the time remaining until the current window for the scope key resets.
ruleIndex	The index of the rule that produced the decision.

Property Details

key

The derived rate limit key.

key?: string

Property Value

string

retryAfterMs

Approximate delay before another activity would be accepted.

For fixed-window limits, this is the time remaining until the current window for the scope key resets.

retryAfterMs: number

Property Value

number

ruleIndex

The index of the rule that produced the decision.

ruleIndex: number

Property Value

number