Skip to main content

Class: GitHubProvider

Extends​

  • BaseGitHubProvider<GithubUpdateInfo>

Constructors​

Constructor​

new GitHubProvider(options, updater, runtimeOptions): GitHubProvider

Parameters​

options​

GithubOptions

updater​

AppUpdater

runtimeOptions​

ProviderRuntimeOptions

Returns​

GitHubProvider

Overrides​

BaseGitHubProvider<GithubUpdateInfo>.constructor

Properties​

baseApiUrl​

protected readonly baseApiUrl: URL

Inherited from​

BaseGitHubProvider.baseApiUrl

baseUrl​

protected readonly baseUrl: URL

Inherited from​

BaseGitHubProvider.baseUrl

executor​

protected readonly executor: ElectronHttpExecutor

Inherited from​

BaseGitHubProvider.executor

options​

protected readonly options: GithubOptions

Inherited from​

BaseGitHubProvider.options

Accessors​

fileExtraDownloadHeaders​

Get Signature​

get fileExtraDownloadHeaders(): OutgoingHttpHeaders | null

Returns​

OutgoingHttpHeaders | null

Inherited from​

BaseGitHubProvider.fileExtraDownloadHeaders

isUseMultipleRangeRequest​

Get Signature​

get isUseMultipleRangeRequest(): boolean

Returns​

boolean

Inherited from​

BaseGitHubProvider.isUseMultipleRangeRequest

Methods​

computeGithubBasePath()​

protected computeGithubBasePath(result): string

Parameters​

result​

string

Returns​

string

Inherited from​

BaseGitHubProvider.computeGithubBasePath

createRequestOptions()​

protected createRequestOptions(url, headers?): RequestOptions

Parameters​

url​

URL

headers?​

OutgoingHttpHeaders | null

Returns​

RequestOptions

Inherited from​

BaseGitHubProvider.createRequestOptions

getBlockMapFiles()​

getBlockMapFiles(baseUrl, oldVersion, newVersion, oldBlockMapFileBaseUrl?): URL[] | Promise<URL[]>

Parameters​

baseUrl​

URL

oldVersion​

string

newVersion​

string

oldBlockMapFileBaseUrl?​

string | null

Returns​

URL[] | Promise<URL[]>

Inherited from​

BaseGitHubProvider.getBlockMapFiles

getCustomChannelName()​

protected getCustomChannelName(channel): string

Parameters​

channel​

string

Returns​

string

Inherited from​

BaseGitHubProvider.getCustomChannelName

getDefaultChannelName()​

protected getDefaultChannelName(): string

Returns​

string

Inherited from​

BaseGitHubProvider.getDefaultChannelName

getLatestVersion()​

getLatestVersion(): Promise<GithubUpdateInfo>

Returns​

Promise<GithubUpdateInfo>

Overrides​

BaseGitHubProvider.getLatestVersion

httpRequest()​

protected httpRequest(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?​

CancellationToken

Returns​

Promise<string | null>

Inherited from​

BaseGitHubProvider.httpRequest

resolveFiles()​

resolveFiles(updateInfo): ResolvedUpdateFileInfo[]

Parameters​

updateInfo​

GithubUpdateInfo

Returns​

ResolvedUpdateFileInfo[]

Overrides​

BaseGitHubProvider.resolveFiles

setRequestHeaders()​

setRequestHeaders(value): void

Parameters​

value​

OutgoingHttpHeaders | null

Returns​

void

Inherited from​

BaseGitHubProvider.setRequestHeaders