Package version:

Class BaseRequestPolicyAbstract

The base class from which all request policies derive.

Hierarchy (view full)

Implements

Constructors

constructor

Properties

_nextPolicy _options

Methods

log sendRequest shouldLog

Constructors

Protectedconstructor

  • new BaseRequestPolicy(_nextPolicy, _options): BaseRequestPolicy

  • The main method to implement that manipulates a request/response.

    Parameters

    • _nextPolicy: RequestPolicy

      The next policy in the pipeline. Each policy is responsible for executing the next one if the request is to continue through the pipeline.

    • _options: RequestPolicyOptionsLike

      The options that can be passed to a given request policy.

    Returns BaseRequestPolicy

Properties

Readonly_nextPolicy

_nextPolicy: RequestPolicy

The next policy in the pipeline. Each policy is responsible for executing the next one if the request is to continue through the pipeline.

Readonly_options

_options: RequestPolicyOptionsLike

The options that can be passed to a given request policy.

Methods

log

  • log(logLevel, message): void

  • 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.

    Parameters

    • logLevel: HttpPipelineLogLevel

      The log level of this log.

    • message: string

      The message of this log.

    Returns void

AbstractsendRequest

  • sendRequest(webResource): Promise<HttpOperationResponse>

  • Sends a network request based on the given web resource.

    Parameters

    • webResource: WebResourceLike

      A WebResourceLike that describes a HTTP request to be made.

    Returns Promise<HttpOperationResponse>

shouldLog

  • shouldLog(logLevel): boolean

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

    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.

Settings

Member Visibility