@electron-forge/maker-zip

  • Version 7.4.0
  • Published
  • 15.3 kB
  • 5 dependencies
  • MIT license

Install

npm i @electron-forge/maker-zip
yarn add @electron-forge/maker-zip
pnpm add @electron-forge/maker-zip

Overview

ZIP maker for Electron Forge

Index

Classes

class MakerZIP

class MakerZIP extends MakerBase<MakerZIPConfig> {}

    property defaultPlatforms

    defaultPlatforms: ForgePlatform[];

      property name

      name: string;

        method isSupportedOnCurrentPlatform

        isSupportedOnCurrentPlatform: () => boolean;

          method make

          make: ({
          dir,
          makeDir,
          appName,
          packageJSON,
          targetArch,
          targetPlatform,
          }: MakerOptions) => Promise<string[]>;

            Interfaces

            interface MakerZIPConfig

            interface MakerZIPConfig {}

              property macUpdateManifestBaseUrl

              macUpdateManifestBaseUrl?: string;
              • A URL to the directory containing your existing macOS auto-update RELEASES.json file. If given this maker will download the existing file and add this release to it, also setting the "currentRelease" to this release.

                For instance if your URL is "https://update.example.com/my-app/darwin/x64/RELEASES.json" you should provide "https://update.example.com/my-app/darwin/x64". This logic assumes that you published your files using a forge publisher compatible with the auto updater (e.g. S3).

                Publishing this RELEASES.json will result in clients downloading this version as an update.

                If this option is not set no RELEASES.json file will be generated.

              property macUpdateReleaseNotes

              macUpdateReleaseNotes?: string;
              • Only used if squirrelMacManifestBaseUrl is provided. Used to populate the "notes" field of the releases manifest for macOS updates.

              Package Files (2)

              Dependencies (5)

              Dev Dependencies (3)

              Peer Dependencies (0)

              No peer dependencies.

              Badge

              To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

              You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@electron-forge/maker-zip.

              • Markdown
                [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@electron-forge/maker-zip)
              • HTML
                <a href="https://www.jsdocs.io/package/@electron-forge/maker-zip"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>