Class DeserializationPolicy

Package version

A RequestPolicy that will deserialize HTTP response bodies and headers as they pass through the HTTP pipeline.

Hierarchy

BaseRequestPolicy
- DeserializationPolicy

Implements

RequestPolicy

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DeserializationPolicy(nextPolicy: RequestPolicy, requestPolicyOptions: RequestPolicyOptions, deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): DeserializationPolicy

Overrides BaseRequestPolicy.constructor
- Defined in home/vsts/work/1/s/sdk/core/core-http/src/policies/deserializationPolicy.ts:85
Parameters
- nextPolicy: RequestPolicy
- requestPolicyOptions: RequestPolicyOptions
- Optional deserializationContentTypes: DeserializationContentTypes
- Default value parsingOptions: SerializerOptions = {}
Returns DeserializationPolicy

Properties

_nextPolicy

_nextPolicy: RequestPolicy

_options

_options: RequestPolicyOptionsLike

jsonContentTypes

jsonContentTypes: string[]

xmlCharKey

xmlCharKey: string

xmlContentTypes

xmlContentTypes: string[]

Methods

log

log(logLevel: HttpPipelineLogLevel, message: string): void

Inherited from LogPolicy.log
- Defined in home/vsts/work/1/s/sdk/core/core-http/src/policies/requestPolicy.ts:43
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

sendRequest

sendRequest(request: WebResourceLike): Promise<HttpOperationResponse>

Implementation of RequestPolicy.sendRequest

Overrides BaseRequestPolicy.sendRequest
- Defined in home/vsts/work/1/s/sdk/core/core-http/src/policies/deserializationPolicy.ts:102
Parameters
- request: WebResourceLike
Returns Promise<HttpOperationResponse>

shouldLog

shouldLog(logLevel: HttpPipelineLogLevel): boolean

Inherited from LogPolicy.shouldLog
- Defined in home/vsts/work/1/s/sdk/core/core-http/src/policies/requestPolicy.ts:33
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.

Generated using TypeDoc