@electron/get

method download

download: (
    url: string,
    targetFilePath: string,
    options?: GotDownloaderOptions
) => Promise<void>;

method download

download: (url: string, targetFilePath: string, options: T) => Promise<void>;

• Download an artifact from an arbitrary URL to a file path on system

  Parameter url

  URL of the file to download

  Parameter targetFilePath

  Filesystem path to download the artifact to (including the file name)

  Parameter options

  Options to pass to the downloader

property cacheMode

cacheMode?: ElectronDownloadCacheMode;

• Controls the cache read and write behavior.

  When set to either ReadOnly or Bypass, the caller is responsible for cleaning up the returned file path once they are done using it (e.g. via fs.remove(path.dirname(pathFromElectronGet))).

  When set to either WriteOnly or ReadWrite (the default), the caller should not move or delete the file path that is returned as the path points directly to the disk cache.

  This option cannot be used in conjunction with ElectronDownloadRequestOptions.force.

property cacheRoot

cacheRoot?: string;

• The directory that caches Electron artifact downloads.

property checksums

checksums?: Record<string, string>;

• Provides checksums for the artifact as strings. Can be used if you already know the checksums of the Electron artifact you are downloading and want to skip the checksum file download without skipping the checksum validation.

  This should be an object whose keys are the file names of the artifacts and the values are their respective SHA256 checksums.

  Example 1

  {
    "electron-v4.0.4-linux-x64.zip": "877617029f4c0f2b24f3805a1c3554ba166fda65c4e88df9480ae7b6ffa26a22"
  }

property downloader

downloader?: Downloader<DownloadOptions>;

• A custom Downloader class used to download artifacts. Defaults to the built-in GotDownloader.

property downloadOptions

downloadOptions?: DownloadOptions;

• Options passed to the downloader module.

  See Also

  • GotDownloaderOptions for options for the default GotDownloader.

property force

force?: boolean;

• Whether to download an artifact regardless of whether it's in the cache directory.

  Deprecated

  This option is deprecated and directly maps to `cacheMode: ElectronDownloadCacheMode.WriteOnly`

property mirrorOptions

mirrorOptions?: MirrorOptions;

• Options related to specifying an artifact mirror.

property tempDirectory

tempDirectory?: string;

• A temporary directory for downloads. It is used before artifacts are put into cache.

property unsafelyDisableChecksums

unsafelyDisableChecksums?: boolean;

• When set to true, disables checking that the artifact download completed successfully with the correct payload.

property customDir

customDir?: string;

• The name of the directory to download from, often scoped by version number e.g 'v4.0.4'

property customFilename

customFilename?: string;

• The name of the asset to download, e.g 'electron-v4.0.4-linux-x64.zip'

property customVersion

customVersion?: string;

• The version of the asset to download, e.g '4.0.4'

property mirror

mirror?: string;

• The base URL of the mirror to download from. e.g https://github.com/electron/electron/releases/download

property nightly_mirror

nightly_mirror?: string;

• See Also

  • MirrorOptions.nightlyMirror

  Deprecated

property nightlyMirror

nightlyMirror?: string;

• The mirror URL for [electron-nightly](https://npmjs.com/package/electron-nightly), which lives in a separate npm package.

property resolveAssetURL

resolveAssetURL?: (opts: DownloadOptions) => Promise<string>;

• A function allowing customization of the url returned from getArtifactRemoteURL().

member Bypass

Bypass = 3

• Bypasses the cache completely, neither reads from nor writes to the cache

member ReadOnly

ReadOnly = 1

• Reads from the cache if present Will **not** write back to the cache after fetching missing artifact

member ReadWrite

ReadWrite = 0

• Reads from the cache if present Writes to the cache after fetch if not present

member WriteOnly

WriteOnly = 2

• Skips reading from the cache Will write back into the cache, overwriting anything currently in the cache after fetch