Class HttpTransport

Hierarchy

HttpTransport

Implements

Transport

Constructors

constructor

new HttpTransport(options, logger?): 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

Type declaration

Optional baseUrl?: string
Optional instanceUrl?: string

`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, responseBuffer): Promise<Buffer>
Parameters
- response: IncomingMessage
- responseBuffer: Buffer
Returns Promise<Buffer>
- Defined in packages/salesforce/src/connection/httpTransport.ts:415

`Private` encodeBody

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

`Private` encodeMultipartBody

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

`Private` getFeatureList

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

`Private` getRedirectRequest

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

`Private` handleResponse

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

httpRequest

httpRequest(info): 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:191
httpRequest(info, options?): Promise<HttpResponse>
Parameters
- info: HttpRequestInfo
- Optional options: object
Returns Promise<HttpResponse>
Implementation of Transport.httpRequest
- Defined in packages/salesforce/src/connection/httpTransport.ts:192

`Private` isRedirect

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

`Private` parseContentType

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

`Private` parseResponseBody

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

`Private` parseUrl

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

`Private` prepareRequest

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

`Private` prepareRequestBody

prepareRequestBody(info): undefined | string | Buffer
Parameters
- info: HttpRequestInfo
Returns undefined | string | Buffer
- Defined in packages/salesforce/src/connection/httpTransport.ts:296

`Private` sendRequestBody

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

Class HttpTransport

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: Partial<HttpTransportOptions & { baseUrl?: string; instanceUrl?: string; }>

logger: ILogger = ...

Returns HttpTransport

Properties

bodyEncoding

Private cookies

Private Readonly logger

Private multiPartBoundary

options

Type declaration

Optional baseUrl?: string

Optional instanceUrl?: string

Static enableResponseLogging

Static httpAgent

Static options

Methods

Private decodeResponseBody

Parameters

response: IncomingMessage

responseBuffer: Buffer

Returns Promise<Buffer>

Private encodeBody

Parameters

body: unknown

contentType: undefined | string

Returns undefined | string | Buffer

Private encodeMultipartBody

Parameters

parts: HttpRequestPart[]

Returns Buffer

Private getFeatureList

Returns string[]

Private getRedirectRequest

Parameters

response: IncomingMessage

info: HttpRequestInfo

Returns HttpRequestInfo

Private handleResponse

Parameters

request: HttpRequestInfo

response: IncomingMessage

Returns Promise<HttpResponse>

httpRequest

Parameters

info: HttpRequestInfo

Returns Promise<HttpResponse>

Parameters

info: HttpRequestInfo

Optional options: object

Returns Promise<HttpResponse>

Private isRedirect

Parameters

response: IncomingMessage

Returns undefined | boolean | 0

Private parseContentType

Parameters

contentTypeHeader: undefined | string

Returns undefined | HttpContentType

Private parseResponseBody

Parameters

response: IncomingMessage

responseBuffer: Buffer

Returns string | object

Private parseUrl

Parameters

url: string

Returns URL

Private prepareRequest

Parameters

info: HttpRequestInfo

options: Partial<HttpTransportOptions & {
baseUrl?: string;
instanceUrl?: string;
}>

`Private` cookies

`Private` `Readonly` logger

`Private` multiPartBoundary

`Optional` baseUrl?: string

`Optional` instanceUrl?: string

`Static` enableResponseLogging

`Static` httpAgent

`Static` options

`Private` decodeResponseBody

`Private` encodeBody

`Private` encodeMultipartBody

`Private` getFeatureList

`Private` getRedirectRequest

`Private` handleResponse

`Optional` options: object

`Private` isRedirect

`Private` parseContentType

`Private` parseResponseBody

`Private` parseUrl

`Private` prepareRequest

`Private` prepareRequestBody

`Private` sendRequestBody