Type Alias ThrottlingResource

The rules and setup for throttling

type ThrottlingResource = {
    capacity?: number;
    initialTokenCount?: number;
    recurrenceRule?: string;
    referenceTimestamp?: string;
    replenishRate?: number;
    timezone?: string;
}
Index

Properties

capacity? initialTokenCount? recurrenceRule? referenceTimestamp? replenishRate? timezone?

Properties

capacity?: number

the maximum number of tokens that the bucket can contain

initialTokenCount?: number

the initial amount of tokens in the bucket upon creation. cannot exceed capacity.

recurrenceRule?: string

A string that supports a subset of RFC5545 recurrence rule directives.

referenceTimestamp?: string

a date and time reference specified in RFC3339 format

replenishRate?: number

the amount of tokens to insert into the bucket on the specified interval. (tokens exceeding capacity are discarded)

timezone?: string

the timezone for time calculations in this throttlingresource, for current time and time reference.

Settings

Member Visibility

On This Page

Properties