From ea78204715746ca1fc3ec27252160eb83a9eb237 Mon Sep 17 00:00:00 2001 From: "electron-ecosystem-docs-publisher[bot]" <148823412+electron-ecosystem-docs-publisher[bot]@users.noreply.github.com> Date: Wed, 7 Feb 2024 18:27:06 +0000 Subject: [PATCH] Publish [skip ci] --- main/functions/download.html | 2 +- main/functions/downloadArtifact.html | 2 +- main/functions/getHostArch.html | 2 +- main/functions/initializeProxy.html | 2 +- main/interfaces/Downloader.html | 4 ++-- main/interfaces/ElectronDownloadRequest.html | 6 +++--- .../ElectronDownloadRequestOptions.html | 18 +++++++++--------- main/interfaces/MirrorOptions.html | 16 ++++++++-------- main/types/DownloadOptions.html | 2 +- main/types/ElectronArtifactDetails.html | 2 +- main/types/ElectronGenericArtifactDetails.html | 2 +- .../types/ElectronPlatformArtifactDetails.html | 2 +- ...ronPlatformArtifactDetailsWithDefaults.html | 2 +- main/types/Omit.html | 2 +- 14 files changed, 32 insertions(+), 32 deletions(-) diff --git a/main/functions/download.html b/main/functions/download.html index e797cecc..d22b4e95 100644 --- a/main/functions/download.html +++ b/main/functions/download.html @@ -33,7 +33,7 @@
version: string
Optional options: ElectronDownloadRequestOptions

Returns Promise<string>

+
  • Defined in index.ts:187
    • diff --git a/main/functions/downloadArtifact.html b/main/functions/downloadArtifact.html index 1480335b..40eb75f5 100644 --- a/main/functions/downloadArtifact.html +++ b/main/functions/downloadArtifact.html @@ -29,7 +29,7 @@

    Parameters

    _artifactDetails: ElectronPlatformArtifactDetailsWithDefaults

    Returns Promise<string>

    +
  • Defined in index.ts:105
    • diff --git a/main/functions/getHostArch.html b/main/functions/getHostArch.html index 0e2313a9..14029631 100644 --- a/main/functions/getHostArch.html +++ b/main/functions/getHostArch.html @@ -24,7 +24,7 @@

    Function getHostArch

    Returns string

    +
  • Defined in utils.ts:72
    • diff --git a/main/functions/initializeProxy.html b/main/functions/initializeProxy.html index 77bc51f0..47bacd26 100644 --- a/main/functions/initializeProxy.html +++ b/main/functions/initializeProxy.html @@ -23,7 +23,7 @@

    Function initializeProxy

    Returns void

    +
  • Defined in proxy.ts:9
    • diff --git a/main/interfaces/Downloader.html b/main/interfaces/Downloader.html index c924e66e..a7f08025 100644 --- a/main/interfaces/Downloader.html +++ b/main/interfaces/Downloader.html @@ -25,7 +25,7 @@

    Hierarchy

    • Downloader
    +
  • Defined in Downloader.ts:1
    • @@ -53,7 +53,7 @@
    targetFilePath: string
    options: T

    Returns Promise<void>

    +
  • Defined in Downloader.ts:2
    • diff --git a/main/interfaces/ElectronDownloadRequest.html b/main/interfaces/ElectronDownloadRequest.html index e0d045c1..f9ebc3f1 100644 --- a/main/interfaces/ElectronDownloadRequest.html +++ b/main/interfaces/ElectronDownloadRequest.html @@ -20,7 +20,7 @@

    Hierarchy

    • ElectronDownloadRequest
    +
  • Defined in types.ts:44
    • @@ -43,14 +43,14 @@

    artifactName

    +
  • Defined in types.ts:54

    • version

    version: string

    The version of Electron associated with the artifact.

    +
  • Defined in types.ts:48
    • diff --git a/main/interfaces/ElectronDownloadRequestOptions.html b/main/interfaces/ElectronDownloadRequestOptions.html index ae646038..1e2fe3b2 100644 --- a/main/interfaces/ElectronDownloadRequestOptions.html +++ b/main/interfaces/ElectronDownloadRequestOptions.html @@ -20,7 +20,7 @@

    Hierarchy

    • ElectronDownloadRequestOptions
    +
  • Defined in types.ts:57
    • @@ -51,7 +51,7 @@

    Optional

    +
  • Defined in types.ts:90

    • Optional checksums

    checksums?: Record<string, string>
    @@ -63,14 +63,14 @@

    Optional

    +
  • Defined in types.ts:80

    • Optional downloadOptions

    downloadOptions?: any

    Options passed to the downloader module.

    +
  • Defined in types.ts:94

    • Optional downloader

    downloader?: Downloader<any>
    @@ -78,7 +78,7 @@

    Optional

    +
  • Defined in types.ts:103

    • Optional force

    force?: boolean
    @@ -86,14 +86,14 @@

    OptionalDefaults to false.

    +
  • Defined in types.ts:63

    • Optional mirrorOptions

    mirrorOptions?: MirrorOptions

    Options related to specifying an artifact mirror.

    +
  • Defined in types.ts:98

    • Optional tempDirectory

    tempDirectory?: string
    @@ -101,7 +101,7 @@

    Optional

    +
  • Defined in types.ts:108

    • Optional unsafelyDisableChecksums

    unsafelyDisableChecksums?: boolean
    @@ -110,7 +110,7 @@

    OptionalDefaults to false.

    +
  • Defined in types.ts:70
    • diff --git a/main/interfaces/MirrorOptions.html b/main/interfaces/MirrorOptions.html index 776118b3..b739357b 100644 --- a/main/interfaces/MirrorOptions.html +++ b/main/interfaces/MirrorOptions.html @@ -20,7 +20,7 @@

    Hierarchy

    • MirrorOptions
    +
  • Defined in types.ts:8
    • @@ -45,7 +45,7 @@

    Optional

    +
  • Defined in types.ts:26

    • Optional customFilename

    customFilename?: string
    @@ -53,7 +53,7 @@

    Optional

    +
  • Defined in types.ts:31

    • Optional customVersion

    customVersion?: string
    @@ -61,7 +61,7 @@

    Optional

    +
  • Defined in types.ts:36

    • Optional mirror

    mirror?: string
    @@ -69,21 +69,21 @@

    Optionalhttps://github.com/electron/electron/releases/download

    +
  • Defined in types.ts:21

    • Optional nightlyMirror

    nightlyMirror?: string

    The Electron nightly-specific mirror URL.

    +
  • Defined in types.ts:16

    • Optional nightly_mirror

    nightly_mirror?: string

    DEPRECATED - see nightlyMirror.

    +
  • Defined in types.ts:12

    • Optional resolveAssetURL

    resolveAssetURL?: ((opts: any) => Promise<string>)
    @@ -104,7 +104,7 @@

    Parameters

    opts: any

    Returns Promise<string>

    +
  • Defined in types.ts:41
    • diff --git a/main/types/DownloadOptions.html b/main/types/DownloadOptions.html index 9ec22828..8d483652 100644 --- a/main/types/DownloadOptions.html +++ b/main/types/DownloadOptions.html @@ -17,7 +17,7 @@

    Type alias DownloadOptions

    DownloadOptions: any
    +
  • Defined in types.ts:6
    • diff --git a/main/types/ElectronArtifactDetails.html b/main/types/ElectronArtifactDetails.html index b8aa58b0..154e8187 100644 --- a/main/types/ElectronArtifactDetails.html +++ b/main/types/ElectronArtifactDetails.html @@ -17,7 +17,7 @@

    Type alias ElectronArtifactDetails

    ElectronArtifactDetails: ElectronPlatformArtifactDetails | ElectronGenericArtifactDetails
    +
  • Defined in types.ts:136
    • diff --git a/main/types/ElectronGenericArtifactDetails.html b/main/types/ElectronGenericArtifactDetails.html index 556126cb..d79b0c33 100644 --- a/main/types/ElectronGenericArtifactDetails.html +++ b/main/types/ElectronGenericArtifactDetails.html @@ -17,7 +17,7 @@

    Type alias ElectronGenericArtifactDetails

    ElectronGenericArtifactDetails: {
        isGeneric: true;
    } & ElectronDownloadRequest & ElectronDownloadRequestOptions
    +
  • Defined in types.ts:131
    • diff --git a/main/types/ElectronPlatformArtifactDetails.html b/main/types/ElectronPlatformArtifactDetails.html index 9d126355..42e2b02a 100644 --- a/main/types/ElectronPlatformArtifactDetails.html +++ b/main/types/ElectronPlatformArtifactDetails.html @@ -17,7 +17,7 @@

    Type alias ElectronPlatformArtifactDetails

    ElectronPlatformArtifactDetails: {
        arch: string;
        artifactSuffix?: string;
        isGeneric?: false;
        platform: string;
    } & ElectronDownloadRequest & ElectronDownloadRequestOptions
    +
  • Defined in types.ts:111
    • diff --git a/main/types/ElectronPlatformArtifactDetailsWithDefaults.html b/main/types/ElectronPlatformArtifactDetailsWithDefaults.html index 4c6e498f..4db05b8e 100644 --- a/main/types/ElectronPlatformArtifactDetailsWithDefaults.html +++ b/main/types/ElectronPlatformArtifactDetailsWithDefaults.html @@ -17,7 +17,7 @@

    Type alias ElectronPlatformArtifactDetailsWithDefaults

    ElectronPlatformArtifactDetailsWithDefaults: Omit<ElectronPlatformArtifactDetails, "platform" | "arch"> & {
        arch?: string;
        platform?: string;
    } | ElectronGenericArtifactDetails
    +
  • Defined in types.ts:142
    • diff --git a/main/types/Omit.html b/main/types/Omit.html index f88daab0..690364cb 100644 --- a/main/types/Omit.html +++ b/main/types/Omit.html @@ -24,7 +24,7 @@

    T

  • K

    • +
  • Defined in types.ts:140