Installation

npm install --save @types/electron-installer-dmg

Summary

This package contains type definitions for electron-installer-dmg (https://github.com/electron-userland/electron-installer-dmg).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/electron-installer-dmg.

index.d.ts

1import appdmg = require("appdmg");
2
3declare namespace createDMG {
4    interface Content {
5        path: string;
6        type: "link" | "file";
7        x: number;
8        y: number;
9    }
10
11    interface CreateOptions {
12        /**
13         * Additional options to pass through to [`appdmg`](https://npm.im/appdmg).
14         * You can use this to set additional features like `background-color` and `code-sign`.
15         * See the docs of the `appdmg` module for all possible options.
16         */
17        additionalDMGOptions?: Partial<appdmg.Specification>;
18        /**
19         * The `.app` directory generated by
20         * [electron-packager](https://github.com/electron-userland/electron-packager).
21         */
22        appPath: string;
23        /** Path to the background for the DMG window. Background image should be of size 658×498. */
24        background?: string;
25        /**
26         * The content that will appear in the window when user opens the .dmg file.
27         * [Default: Array of two icons, application and application destination folder].
28         */
29        contents?: Content[] | ((opts: ContentsOptions) => Content[]);
30        /** Enable debug message output. */
31        debug?: boolean;
32        /** Disk image format. [Default: `UDZO`]. */
33        format?: "UDRW" | "UDRO" | "UDCO" | "UDZO" | "UDBZ" | "ULFO";
34        /** Path to the icon to use for the app in the DMG window. */
35        icon?: string;
36        /** How big to make the icon for the app in the DMG. [Default: `80`]. */
37        iconSize?: number;
38        /** The application name. */
39        name: string;
40        /** The directory to put the DMG into. [Default: `process.cwd()`]. */
41        out?: string;
42        /** Overwrite an existing DMG file if if already exists. */
43        overwrite?: boolean;
44        /** The title of the produced DMG, which will be shown when mounted. */
45        title?: string;
46    }
47
48    /**
49     * Options passed to the `contents` function.
50     */
51    // Note: In the actual implementation, the entire `CreateOptions` object is
52    // passed to the `contents` function, but in the type we omit the `contents`
53    // field to avoid recursion.
54    type ContentsOptions = Omit<CreateOptions, "contents">;
55}
56
57declare function createDMG(createOptions: createDMG.CreateOptions): Promise<createDMG.CreateOptions>;
58
59export = createDMG;
60

Additional Details

• Last updated: Mon, 06 Nov 2023 22:41:05 GMT
• Dependencies: @types/appdmg

Credits

These definitions were written by Florian Imdahl.