UNPKG

1.27 kBTypeScriptView Raw
1import { ElectronDownloadRequestOptions, ElectronGenericArtifactDetails, ElectronPlatformArtifactDetailsWithDefaults } from './types';
2export { getHostArch } from './utils';
3export { initializeProxy } from './proxy';
4export * from './types';
5/**
6 * Downloads an artifact from an Electron release and returns an absolute path
7 * to the downloaded file.
8 *
9 * Each release of Electron comes with artifacts, many of which are
10 * platform/arch-specific (e.g. `ffmpeg-v31.0.0-darwin-arm64.zip`) and others that
11 * are generic (e.g. `SHASUMS256.txt`).
12 *
13 *
14 * @param artifactDetails - The information required to download the artifact
15 * @category Download Artifact
16 */
17export declare function downloadArtifact(artifactDetails: ElectronPlatformArtifactDetailsWithDefaults | ElectronGenericArtifactDetails): Promise<string>;
18/**
19 * Downloads the Electron binary for a specific version and returns an absolute path to a
20 * ZIP file.
21 *
22 * @param version - The version of Electron you want to download (e.g. `31.0.0`)
23 * @param options - Options to customize the download behavior
24 * @returns An absolute path to the downloaded ZIP file
25 * @category Download Electron
26 */
27export declare function download(version: string, options?: ElectronDownloadRequestOptions): Promise<string>;