Skip to main content
Version: v2

IThrottlingWarning Interface

Warning emitted when requests to storage are being throttled

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

To use, import via @fluidframework/core-interfaces/legacy.

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

Signature​

export interface IThrottlingWarning extends IErrorBase

Extends: IErrorBase

Properties​

PropertyAlertsModifiersTypeDescription
errorTypeBetareadonlytypeof FluidErrorTypes.throttlingErrorA type tag differentiating kinds of errors emitted by the container.
retryAfterSecondsBetareadonlynumber

Property Details​

errorType​

A type tag differentiating kinds of errors emitted by the container.

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​

readonly errorType: typeof FluidErrorTypes.throttlingError;

Type: typeof FluidErrorTypes.throttlingError

retryAfterSeconds​

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​

readonly retryAfterSeconds: number;

Type: number