Skip to main content

Interface: ApiRequestOptions

The options of an API request, see HttpExecutor.request.

Extends​

  • RequestOptions

Properties​

_defaultAgent?​

optional _defaultAgent?: Agent

Inherited from​

RequestOptions._defaultAgent


agent?​

optional agent?: boolean | Agent

Inherited from​

RequestOptions.agent


auth?​

optional auth?: string | null

Inherited from​

RequestOptions.auth


createConnection?​

optional createConnection?: (options, oncreate) => Duplex | null | undefined

Parameters​

options​

ClientRequestArgs

oncreate​

(err, socket) => void

Returns​

Duplex | null | undefined

Inherited from​

RequestOptions.createConnection


defaultPort?​

optional defaultPort?: string | number

Inherited from​

RequestOptions.defaultPort


family?​

optional family?: number

Inherited from​

RequestOptions.family


headers?​

optional headers?: OutgoingHttpHeaders

Inherited from​

RequestOptions.headers


hints?​

optional hints?: number

Inherited from​

RequestOptions.hints


host?​

optional host?: string | null

Inherited from​

RequestOptions.host


hostname?​

optional hostname?: string | null

Inherited from​

RequestOptions.hostname


insecureHTTPParser?​

optional insecureHTTPParser?: boolean

Inherited from​

RequestOptions.insecureHTTPParser


joinDuplicateHeaders?​

optional joinDuplicateHeaders?: boolean

Inherited from​

RequestOptions.joinDuplicateHeaders


localAddress?​

optional localAddress?: string

Inherited from​

RequestOptions.localAddress


localPort?​

optional localPort?: number

Inherited from​

RequestOptions.localPort


lookup?​

optional lookup?: LookupFunction

Inherited from​

RequestOptions.lookup


maxHeaderSize?​

optional maxHeaderSize?: number

Default​

16384

Inherited from​

RequestOptions.maxHeaderSize


maxResponseSize?​

optional maxResponseSize?: number

The largest body, in bytes, read into memory (set by electron-updater for update info, which is parsed before it is verified): a larger response fails the request with ERR_UPDATER_RESPONSE_TOO_LARGE and aborts it. Applies when it is a finite number of at least 0, and is kept on redirects, whose options are copied from these.


method?​

optional method?: string

Inherited from​

RequestOptions.method


ownHeaders?​

optional ownHeaders?: OutgoingHttpHeaders | null

The headers of headers the request's sender builds for this request itself, such as Accept or Range: a hop to another origin adds back the ones its CrossOriginHeaderPolicy left out, so the policy decides only the other headers. Kept on redirects.


path?​

optional path?: string | null

Inherited from​

RequestOptions.path


port?​

optional port?: string | number | null

Inherited from​

RequestOptions.port


protocol?​

optional protocol?: string | null

Inherited from​

RequestOptions.protocol


redirectedFromNonLoopback?​

optional redirectedFromNonLoopback?: boolean

Set by HttpExecutor.prepareRedirectUrlOptions on a redirect's options when a URL of the redirect chain so far is not on a loopback host (see isLoopbackHostname): electron-updater rejects a redirect from such a host to a loopback one.


setDefaultHeaders?​

optional setDefaultHeaders?: boolean

Inherited from​

RequestOptions.setDefaultHeaders


setHost?​

optional setHost?: boolean

Inherited from​

RequestOptions.setHost


signal?​

optional signal?: AbortSignal

Inherited from​

RequestOptions.signal


socketPath?​

optional socketPath?: string

Inherited from​

RequestOptions.socketPath


timeout?​

optional timeout?: number

Inherited from​

RequestOptions.timeout


uniqueHeaders?​

optional uniqueHeaders?: (string | string[])[]

Inherited from​

RequestOptions.uniqueHeaders