main.d.ts 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. /// <reference types="node" />
  2. import { CancellationToken, PackageFileInfo, ProgressInfo, UpdateFileInfo, UpdateInfo } from "builder-util-runtime";
  3. import { EventEmitter } from "events";
  4. import { URL } from "url";
  5. import { AppUpdater } from "./AppUpdater";
  6. import { LoginCallback } from "./electronHttpExecutor";
  7. export { AppUpdater, NoOpLogger } from "./AppUpdater";
  8. export { UpdateInfo };
  9. export { CancellationToken } from "builder-util-runtime";
  10. export { Provider } from "./providers/Provider";
  11. export declare const autoUpdater: AppUpdater;
  12. export interface ResolvedUpdateFileInfo {
  13. readonly url: URL;
  14. readonly info: UpdateFileInfo;
  15. packageInfo?: PackageFileInfo;
  16. }
  17. export declare function getDefaultChannelName(): string;
  18. export declare function getCustomChannelName(channel: string): string;
  19. export declare function getCurrentPlatform(): string;
  20. export declare function isUseOldMacProvider(): boolean;
  21. export declare function getChannelFilename(channel: string): string;
  22. export interface UpdateCheckResult {
  23. readonly updateInfo: UpdateInfo;
  24. readonly downloadPromise?: Promise<Array<string>> | null;
  25. readonly cancellationToken?: CancellationToken;
  26. /** @deprecated */
  27. readonly versionInfo: UpdateInfo;
  28. }
  29. export declare type UpdaterEvents = "login" | "checking-for-update" | "update-available" | "update-cancelled" | "download-progress" | "update-downloaded" | "error";
  30. export declare const DOWNLOAD_PROGRESS: UpdaterEvents;
  31. export declare const UPDATE_DOWNLOADED: UpdaterEvents;
  32. export declare type LoginHandler = (authInfo: any, callback: LoginCallback) => void;
  33. export declare class UpdaterSignal {
  34. private emitter;
  35. constructor(emitter: EventEmitter);
  36. /**
  37. * Emitted when an authenticating proxy is [asking for user credentials](https://github.com/electron/electron/blob/master/docs/api/client-request.md#event-login).
  38. */
  39. login(handler: LoginHandler): void;
  40. progress(handler: (info: ProgressInfo) => void): void;
  41. updateDownloaded(handler: (info: UpdateInfo) => void): void;
  42. updateCancelled(handler: (info: UpdateInfo) => void): void;
  43. }
  44. export interface Logger {
  45. info(message?: any): void;
  46. warn(message?: any): void;
  47. error(message?: any): void;
  48. debug?(message: string): void;
  49. }
  50. export declare function newUrlFromBase(pathname: string, baseUrl: URL, addRandomQueryToAvoidCaching?: boolean): URL;