Skip to main content

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

Property Alerts Modifiers Type Description
errorType Alpha readonly typeof FluidErrorTypes.throttlingError A type tag differentiating kinds of errors emitted by the container.
retryAfterSeconds Alpha readonly number

Property Details

errorType

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

This API is provided as an alpha preview and may change without notice.

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

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 as an alpha preview and may change without notice.

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

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

Signature

readonly retryAfterSeconds: number;

Type: number