Interface: ApiRequestOptions
The options of an API request, see HttpExecutor.request.
Extends
RequestOptions
Properties
_defaultAgent?
optional_defaultAgent?:Agent
Inherited from
RequestOptions._defaultAgent
agent?
optionalagent?:boolean|Agent
Inherited from
RequestOptions.agent
auth?
optionalauth?:string|null
Inherited from
RequestOptions.auth
createConnection?
optionalcreateConnection?: (options,oncreate) =>Duplex|null|undefined
Parameters
options
ClientRequestArgs
oncreate
(err, socket) => void
Returns
Duplex | null | undefined
Inherited from
RequestOptions.createConnection
defaultPort?
optionaldefaultPort?:string|number
Inherited from
RequestOptions.defaultPort
family?
optionalfamily?:number
Inherited from
RequestOptions.family
headers?
optionalheaders?:OutgoingHttpHeaders
Inherited from
RequestOptions.headers
hints?
optionalhints?:number
Inherited from
RequestOptions.hints
host?
optionalhost?:string|null
Inherited from
RequestOptions.host
hostname?
optionalhostname?:string|null
Inherited from
RequestOptions.hostname
insecureHTTPParser?
optionalinsecureHTTPParser?:boolean
Inherited from
RequestOptions.insecureHTTPParser
joinDuplicateHeaders?
optionaljoinDuplicateHeaders?:boolean
Inherited from
RequestOptions.joinDuplicateHeaders
localAddress?
optionallocalAddress?:string
Inherited from
RequestOptions.localAddress
localPort?
optionallocalPort?:number
Inherited from
RequestOptions.localPort
lookup?
optionallookup?:LookupFunction
Inherited from
RequestOptions.lookup
maxHeaderSize?
optionalmaxHeaderSize?:number
Default
16384
Inherited from
RequestOptions.maxHeaderSize
maxResponseSize?
optionalmaxResponseSize?: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?
optionalmethod?:string
Inherited from
RequestOptions.method
ownHeaders?
optionalownHeaders?: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?
optionalpath?:string|null
Inherited from
RequestOptions.path
port?
optionalport?:string|number|null
Inherited from
RequestOptions.port
protocol?
optionalprotocol?:string|null
Inherited from
RequestOptions.protocol
redirectedFromNonLoopback?
optionalredirectedFromNonLoopback?: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?
optionalsetDefaultHeaders?:boolean
Inherited from
RequestOptions.setDefaultHeaders
setHost?
optionalsetHost?:boolean
Inherited from
RequestOptions.setHost
signal?
optionalsignal?:AbortSignal
Inherited from
RequestOptions.signal
socketPath?
optionalsocketPath?:string
Inherited from
RequestOptions.socketPath
timeout?
optionaltimeout?:number
Inherited from
RequestOptions.timeout
uniqueHeaders?
optionaluniqueHeaders?: (string|string[])[]
Inherited from
RequestOptions.uniqueHeaders