@electron/get
    Preparing search index...

    Interface ElectronGenericArtifactDetails

    Options to download a generic (i.e. platform and architecture-agnostic) Electron artifact. Contains all options from ElectronDownloadRequestOptions, but specifies a version and artifactName for the artifact to download.

    interface ElectronGenericArtifactDetails {
        artifactName: string;
        isGeneric: true;
        version: string;
        cacheMode?: ElectronDownloadCacheMode;
        cacheRoot?: string;
        checksums?: Record<string, string>;
        downloader?: Downloader<any>;
        downloadOptions?: any;
        mirrorOptions?: MirrorOptions;
        tempDirectory?: string;
        unsafelyDisableChecksums?: boolean;
    }
    Index

    Properties

    artifactName isGeneric version cacheMode? cacheRoot? checksums? downloader? downloadOptions? mirrorOptions? tempDirectory? unsafelyDisableChecksums?

    Properties

    artifactName: string

    The type of artifact. For example:

    • electron
    • ffmpeg
    isGeneric: true
    version: string

    The version of Electron associated with the artifact.

    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.

    ElectronDownloadCacheMode.ReadWrite

    cacheRoot?: string

    The directory that caches Electron artifact downloads.

    The default value is dependent upon the host platform:

    • Linux: $XDG_CACHE_HOME or ~/.cache/electron/
    • MacOS: ~/Library/Caches/electron/
    • Windows: %LOCALAPPDATA%/electron/Cache or ~/AppData/Local/electron/Cache/
    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.

    {
      "electron-v4.0.4-linux-x64.zip": "877617029f4c0f2b24f3805a1c3554ba166fda65c4e88df9480ae7b6ffa26a22"
    }
    downloader?: Downloader<any>

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

    downloadOptions?: any

    Options passed to the downloader module.

    FetchDownloaderOptions for options for the default FetchDownloader.

    mirrorOptions?: MirrorOptions

    Options related to specifying an artifact mirror.

    tempDirectory?: string

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

    the OS default temporary directory via os.tmpdir()

    unsafelyDisableChecksums?: boolean

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

    false

    Settings

    Member Visibility

    On This Page

    Properties