Documentation
    Preparing search index...

    Interface MakerDMGConfig

    interface MakerDMGConfig {
        additionalDMGOptions?: Omit<
            Specification,
            "title"
            | "background"
            | "icon"
            | "contents"
            | "format"
            | "icon-size",
        >;
        background?: string;
        contents?:
            | SpecificationContents[]
            | ((opts: ElectronInstallerDMGOptions) => SpecificationContents[]);
        format?: "UDRW" | "UDRO" | "UDCO" | "UDZO" | "UDBZ" | "ULFO";
        icon?: string;
        iconSize?: number;
        name?: string;
        overwrite?: boolean;
        title?: string;
    }

    Hierarchy

    • Omit<ElectronInstallerDMGOptions, "name" | "appPath" | "out">
      • MakerDMGConfig
    Index

    Properties

    additionalDMGOptions? background? contents? format? icon? iconSize? name? overwrite? title?

    Properties

    additionalDMGOptions?: Omit<
        Specification,
        "title"
        | "background"
        | "icon"
        | "contents"
        | "format"
        | "icon-size",
    >

    Additional options to pass through to appdmg

    You can use this to set additional features like background-color and code-sign. See the docs of the appdmg module for all possible options.

    background?: string

    Path to the background image for the DMG window. Image should be of size 658x498.

    If you need to want to add a second Retina-compatible size, add a separate @2x image. For example, if your image is called background.png, create a background@2x.png that is double the size.

    contents?:
        | SpecificationContents[]
        | ((opts: ElectronInstallerDMGOptions) => SpecificationContents[])

    The content that will appear in the window when user opens the .dmg file.

    An array of two icons: the application and the /Applications destination folder.

    format?: "UDRW" | "UDRO" | "UDCO" | "UDZO" | "UDBZ" | "ULFO"

    Disk image format.

    Must be one of the following:

    • UDRW -> read/write image
    • UDRO -> read-only image
    • UDCO -> ADC-compressed image
    • UDZO -> zlib-compressed image
    • UDBZ -> bzip2-compressed image
    • ULFO -> lzfse-compressed image (macOS 10.11+ only)

    UDZO

    icon?: string

    Path to the icon to use for the app in the DMG window.

    iconSize?: number

    How big to make the icon for the app in the DMG.

    80
    name?: string
    overwrite?: boolean

    Overwrite an existing DMG file if if already exists.

    title?: string

    The title of the produced DMG, which will be shown when mounted.

    the application name

    Settings

    Member Visibility

    On This Page

    Properties