basic-electron-updater
Version:
A secure, cross-platform auto-update library for Electron Forge apps using GitHub Releases.
22 lines (21 loc) • 718 B
TypeScript
import { GitHubProviderOptions, GitHubReleaseResult } from "./types";
/**
* GitHubProvider fetches release data from the GitHub API for the configured repo.
* Used internally by Updater.
*/
export declare class GitHubProvider {
private repo;
private allowPrerelease;
private channel;
/**
* Create a new GitHubProvider.
* @param options GitHub provider options
*/
constructor(options: GitHubProviderOptions);
/**
* Fetches the latest release matching the config (channel, prerelease, etc).
* @returns GitHubReleaseResult if available, otherwise null
* @throws Error if the GitHub API request fails
*/
getLatestRelease(): Promise<GitHubReleaseResult>;
}