dmg-builder

  • Version 26.8.1
  • Published
  • 144 kB
  • 5 dependencies
  • MIT license

Install

npm i dmg-builder
yarn add dmg-builder
pnpm add dmg-builder

Overview

Utilities to build DMG. Used by [electron-builder](https://github.com/electron-userland/electron-builder).

Index

Classes

class DmgTarget

class DmgTarget extends Target {}

    constructor

    constructor(packager: MacPackager, outDir: string);

      property isAsyncSupported

      isAsyncSupported: boolean;

        property options

        readonly options: DmgOptions;

          property outDir

          readonly outDir: string;

            method build

            build: (appPath: string, arch: Arch) => Promise<void>;

              method computeDmgOptions

              computeDmgOptions: (appPath: string) => Promise<DmgOptions>;

                method computeVolumeName

                computeVolumeName: (arch: Arch, custom?: string | null) => string;

                  Interfaces

                  interface DmgBuildConfig

                  interface DmgBuildConfig {}

                    property "background-color"

                    'background-color'?: string | null;

                      property "badge-icon"

                      'badge-icon'?: string | null;

                        property "compression-level"

                        'compression-level'?: number | null;

                          property "icon-size"

                          'icon-size'?: number | null;

                            property "text-size"

                            'text-size'?: number | null;

                              property background

                              background?: string | null;

                                property contents

                                contents?: Array<{
                                path: string;
                                x: number;
                                y: number;
                                name?: string;
                                type?: 'file' | 'link' | 'position';
                                hide_extension?: boolean;
                                hidden?: boolean;
                                }>;

                                  property filesystem

                                  filesystem?: string;

                                    property format

                                    format?: string;

                                      property icon

                                      icon?: string | null;

                                        property license

                                        license?: string | null;

                                          property shrink

                                          shrink?: boolean;

                                            property size

                                            size?: string | null;

                                              property title

                                              title: string;

                                                property window

                                                window?: {
                                                position?: {
                                                x?: number;
                                                y?: number;
                                                };
                                                size?: {
                                                width?: number;
                                                height?: number;
                                                };
                                                };

                                                  Package Files (1)

                                                  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/dmg-builder.

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