Skip to main content

RateLimiter Class

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/driver-utils/legacy.

For more information about our API support guarantees, see here.

Signature

export declare class RateLimiter

Constructors

Constructor Alerts Description
(constructor)(maxRequests) Alpha Constructs a new instance of the RateLimiter class

Properties

Property Alerts Modifiers Type Description
release Alpha readonly () => void
waitQueueLength Alpha readonly number

Constructor Details

(constructor)

Constructs a new instance of the RateLimiter class

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

constructor(maxRequests: number);

Parameters

Parameter Type Description
maxRequests number

Property Details

release

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

protected readonly release: () => void;

Type: () => void

waitQueueLength

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

get waitQueueLength(): number;

Type: number