RetryPolicy class

Package:

@azure/storage-file

Retry policy with exponential retry and linear retry implemented.

Extends

BaseRequestPolicy

Constructors

RetryPolicy(RequestPolicy, RequestPolicyOptions, IRetryOptions)

Creates an instance of RetryPolicy.

Methods

log(HttpPipelineLogLevel, string)	Attempt to log the provided message to the provided logger. If no logger was provided or if the log level does not meat the logger's threshold, then nothing will be logged.
sendRequest(WebResource)	Sends request.
shouldLog(HttpPipelineLogLevel)	Get whether or not a log with the provided log level should be logged.

Constructor Details

RetryPolicy(RequestPolicy, RequestPolicyOptions, IRetryOptions)

Creates an instance of RetryPolicy.

new RetryPolicy(nextPolicy: RequestPolicy, options: RequestPolicyOptions, retryOptions?: IRetryOptions)

Parameters

nextPolicy

RequestPolicy

options

RequestPolicyOptions

retryOptions

IRetryOptions

Method Details

log(HttpPipelineLogLevel, string)

Attempt to log the provided message to the provided logger. If no logger was provided or if the log level does not meat the logger's threshold, then nothing will be logged.

function log(logLevel: HttpPipelineLogLevel, message: string)

Parameters

logLevel

HttpPipelineLogLevel

The log level of this log.

message

string

The message of this log.

sendRequest(WebResource)

Sends request.

function sendRequest(request: WebResource)

Parameters

request

WebResource

Returns

Promise<HttpOperationResponse>

shouldLog(HttpPipelineLogLevel)

Get whether or not a log with the provided log level should be logged.

function shouldLog(logLevel: HttpPipelineLogLevel)

Parameters

logLevel

HttpPipelineLogLevel

The log level of the log that will be logged.

Returns

boolean

Whether or not a log with the provided log level should be logged.