Abstract Class: Provider<T>
Extended by
Type Parameters
T
T extends UpdateInfo
Constructors
Constructor
protectednew Provider<T>(runtimeOptions):Provider<T>
Parameters
runtimeOptions
Returns
Provider<T>
Properties
executor
protectedreadonlyexecutor:ElectronHttpExecutor
Accessors
feedBaseUrl
Get Signature
get
abstractfeedBaseUrl():URL
Required. Base URL of the update feed: download URLs, and the URLs of the provider's own update info requests (e.g. the channel file),
on its origin get every request header. Any other origin gets only the headers the app's crossOriginHeaders keeps, with this URL as
the hop's from. Anything but a URL fails the update check with ERR_UPDATER_FEED_BASE_URL_NOT_DECLARED.
Returns
URL
fileExtraDownloadHeaders
Get Signature
get fileExtraDownloadHeaders():
OutgoingHttpHeaders|null
Returns
OutgoingHttpHeaders | null
isUseMultipleRangeRequest
Get Signature
get isUseMultipleRangeRequest():
boolean
Returns
boolean
Methods
channelFileRequest()
protectedchannelFileRequest(url,headers?,cancellationToken?):Promise<string|null>
httpRequest for a channel file (latest*.yml), which is read into memory and parsed before anything verifies it: a response
larger than maxUpdateInfoSize fails with ERR_UPDATER_RESPONSE_TOO_LARGE (see ApiRequestOptions.maxResponseSize). Channel files are
a few KB. Release feeds and API responses (release listings and lookups) are not limited: their size depends on the release history.
Parameters
url
URL
headers?
OutgoingHttpHeaders | null
cancellationToken?
Returns
Promise<string | null>
createRequestOptions()
protectedcreateRequestOptions(url,headers?):ApiRequestOptions
Options for an update info request to url, with the updater's request headers and headers, the provider's own for this request (an
Accept, a token). On another origin than feedBaseUrl all of them go through the app's crossOriginHeaders, and the Accept of
headers is added back (see ApiRequestOptions.ownHeaders), also on a redirect to another origin.
Parameters
url
URL
headers?
OutgoingHttpHeaders | null
Returns
getBlockMapFiles()
getBlockMapFiles(
baseUrl,oldVersion,newVersion,oldBlockMapFileBaseUrl?):URL[] |Promise<URL[]>
Parameters
baseUrl
URL
oldVersion
string
newVersion
string
oldBlockMapFileBaseUrl?
string | null
Returns
URL[] | Promise<URL[]>
getCustomChannelName()
protectedgetCustomChannelName(channel):string
Parameters
channel
string
Returns
string
getDefaultChannelName()
protectedgetDefaultChannelName():string
Returns
string
getLatestVersion()
abstractgetLatestVersion():Promise<T>
Returns
Promise<T>
httpRequest()
protectedhttpRequest(url,headers?,cancellationToken?):Promise<string|null>
Method to perform API request only to resolve update info, but not to download update.
Parameters
url
URL
headers?
OutgoingHttpHeaders | null
cancellationToken?
Returns
Promise<string | null>
resolveFiles()
abstractresolveFiles(updateInfo):ResolvedUpdateFileInfo[]
Parameters
updateInfo
T
Returns
setMaxUpdateInfoSize()
setMaxUpdateInfoSize(
value):void
The largest channel file (latest*.yml) read, in bytes (0 for no limit). Set by AppUpdater before each update check, from
autoUpdater.maxUpdateInfoSize or the maxUpdateInfoSize of the publish configuration.
Parameters
value
number
Returns
void
setRequestHeaders()
setRequestHeaders(
value):void
Parameters
value
OutgoingHttpHeaders | null
Returns
void