ThrottlingError Class

Packages > @fluidframework/driver-utils > ThrottlingError

Throttling error class - used to communicate all throttling errors

Signature:

export declare class ThrottlingError extends LoggingError implements IThrottlingWarning 

Extends: LoggingError

Implements: IThrottlingWarning

Constructors

List of constructors for this class
Constructor Modifiers Description
(constructor)(errorMessage, retryAfterSeconds, statusCode) Constructs a new instance of the ThrottlingError class

Properties

List of properties for this class
Property Modifiers Type Description
canRetry (not declared)
errorType (not declared)
retryAfterSeconds number

Constructors

ThrottlingError.(constructor)

Constructs a new instance of the ThrottlingError class

Signature:

constructor(errorMessage: string, retryAfterSeconds: number, statusCode?: number);

Parameters

List of parameters
Parameter Type Description
errorMessage string
retryAfterSeconds number
statusCode number

Properties

canRetry

Signature:

readonly canRetry = true;

errorType

Signature:

readonly errorType = DriverErrorType.throttlingError;

retryAfterSeconds

Signature:

readonly retryAfterSeconds: number;