Class HttpTransport

Implements

Transport

Constructors

constructor

new HttpTransport(
    options: Partial<
        HttpTransportOptions & { baseUrl?: string; instanceUrl?: string },
    >,
    logger?: ILogger,
): HttpTransport
Parameters
- options: Partial<HttpTransportOptions & { baseUrl?: string; instanceUrl?: string }>
- logger: ILogger = ...
Returns HttpTransport
- Defined in packages/salesforce/src/connection/httpTransport.ts:170

Properties

bodyEncoding

bodyEncoding: BufferEncoding = 'utf8'

Encoding used for encoding and decoding response and request bodies

`Private`cookies

cookies: CookieJar = ...

`Private` `Readonly`logger

logger: ILogger = ...

`Private`multiPartBoundary

multiPartBoundary: string = ...

options

options: HttpTransportOptions & { baseUrl?: string; instanceUrl?: string }

Options applied to to this HTTP transport

`Static`enableResponseLogging

enableResponseLogging: boolean = false

Even when debug logging is enable request and response bodies are not logged for performance and security reason. Enabling this flag enables logging of both the request and response bodies including headers

`Static`httpAgent

httpAgent: Agent = ...

Default shared HTTP agent used by this HttpTransport used for connection pooling

`Static`options

options: HttpTransportOptions = ...

Default configuration for the transport options. When no specific value is set for an individual transport the defaults are used instead.

Methods

`Private`decodeResponseBody

decodeResponseBody(
response: IncomingMessage,
responseBuffer: Buffer,
): Promise<Buffer<ArrayBufferLike>>
Parameters
- response: IncomingMessage
- responseBuffer: Buffer
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in packages/salesforce/src/connection/httpTransport.ts:420

`Private`encodeBody

encodeBody(
body: unknown,
contentType: undefined | string,
): undefined | string | Buffer<ArrayBufferLike>
Parameters
- body: unknown
- contentType: undefined | string
Returns undefined | string | Buffer<ArrayBufferLike>
- Defined in packages/salesforce/src/connection/httpTransport.ts:311

`Private`encodeMultipartBody

encodeMultipartBody(parts: HttpRequestPart[]): Buffer
Parameters
- parts: HttpRequestPart[]
Returns Buffer
- Defined in packages/salesforce/src/connection/httpTransport.ts:331

`Private`getFeatureList

getFeatureList(): string[]
Returns string[]
- Defined in packages/salesforce/src/connection/httpTransport.ts:178

`Private`getRedirectRequest

getRedirectRequest(
response: IncomingMessage,
info: HttpRequestInfo,
): HttpRequestInfo
Parameters
- response: IncomingMessage
- info: HttpRequestInfo
Returns HttpRequestInfo
- Defined in packages/salesforce/src/connection/httpTransport.ts:482

`Private`handleResponse

handleResponse(
request: HttpRequestInfo,
response: IncomingMessage,
): Promise<HttpResponse>
Parameters
- request: HttpRequestInfo
- response: IncomingMessage
Returns Promise<HttpResponse>
- Defined in packages/salesforce/src/connection/httpTransport.ts:374

httpRequest

httpRequest(info: HttpRequestInfo): Promise<HttpResponse>
Make a HTTP request to the specified URL
Parameters
- info: HttpRequestInfo
  Request information
Returns Promise<HttpResponse>
Promise with the response
Implementation of Transport.httpRequest
- Defined in packages/salesforce/src/connection/httpTransport.ts:190
httpRequest(info: HttpRequestInfo, options?: object): Promise<HttpResponse>
Make a HTTP request to the specified URL with optional legacy options argument
Parameters
- info: HttpRequestInfo
  Request information
- Optionaloptions: object
  Deprecated options object (unused)
Returns Promise<HttpResponse>
Promise with the response
Implementation of Transport.httpRequest
- Defined in packages/salesforce/src/connection/httpTransport.ts:197

`Private`isRedirect

isRedirect(response: IncomingMessage): undefined | boolean | 0
Parameters
- response: IncomingMessage
Returns undefined | boolean | 0
- Defined in packages/salesforce/src/connection/httpTransport.ts:500

`Private`parseContentType

parseContentType(
contentTypeHeader: undefined | string,
): undefined | HttpContentType
Parameters
- contentTypeHeader: undefined | string
Returns undefined | HttpContentType
- Defined in packages/salesforce/src/connection/httpTransport.ts:469

`Private`parseResponseBody

parseResponseBody(
response: IncomingMessage,
responseBuffer: Buffer,
): string | object
Parameters
- response: IncomingMessage
- responseBuffer: Buffer
Returns string | object
- Defined in packages/salesforce/src/connection/httpTransport.ts:447

`Private`parseUrl

parseUrl(url: string): URL
Parameters
- url: string
Returns URL
- Defined in packages/salesforce/src/connection/httpTransport.ts:504

`Private`prepareRequest

prepareRequest(info: HttpRequestInfo): ClientRequest
Parameters
- info: HttpRequestInfo
Returns ClientRequest
- Defined in packages/salesforce/src/connection/httpTransport.ts:259

`Private`prepareRequestBody

prepareRequestBody(
info: HttpRequestInfo,
): undefined | string | Buffer<ArrayBufferLike>
Parameters
- info: HttpRequestInfo
Returns undefined | string | Buffer<ArrayBufferLike>
- Defined in packages/salesforce/src/connection/httpTransport.ts:301

`Private`sendRequestBody

sendRequestBody(
request: ClientRequest,
body: string | Buffer<ArrayBufferLike>,
): Promise<ClientRequest>
Parameters
- request: ClientRequest
- body: string | Buffer<ArrayBufferLike>
Returns Promise<ClientRequest>
- Defined in packages/salesforce/src/connection/httpTransport.ts:349

Class HttpTransport

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns HttpTransport

Properties

bodyEncoding

Privatecookies

Private Readonlylogger

PrivatemultiPartBoundary

options

StaticenableResponseLogging

StatichttpAgent

Staticoptions

Methods

PrivatedecodeResponseBody

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

PrivateencodeBody

Parameters

Returns undefined | string | Buffer<ArrayBufferLike>

PrivateencodeMultipartBody

Parameters

Returns Buffer

PrivategetFeatureList

Returns string[]

PrivategetRedirectRequest

Parameters

Returns HttpRequestInfo

PrivatehandleResponse

Parameters

Returns Promise<HttpResponse>

httpRequest

Parameters

Returns Promise<HttpResponse>

Parameters

Returns Promise<HttpResponse>

PrivateisRedirect

Parameters

Returns undefined | boolean | 0

PrivateparseContentType

Parameters

Returns undefined | HttpContentType

PrivateparseResponseBody

Parameters

Returns string | object

PrivateparseUrl

Parameters

Returns URL

PrivateprepareRequest

Parameters

Returns ClientRequest

PrivateprepareRequestBody

Parameters

Returns undefined | string | Buffer<ArrayBufferLike>

PrivatesendRequestBody

Parameters

Returns Promise<ClientRequest>

Settings

On This Page

`Private`cookies

`Private` `Readonly`logger

`Private`multiPartBoundary

`Static`enableResponseLogging

`Static`httpAgent

`Static`options

`Private`decodeResponseBody

`Private`encodeBody

`Private`encodeMultipartBody

`Private`getFeatureList

`Private`getRedirectRequest

`Private`handleResponse

`Private`isRedirect

`Private`parseContentType

`Private`parseResponseBody

`Private`parseUrl

`Private`prepareRequest

`Private`prepareRequestBody

`Private`sendRequestBody