@types/appdmg

Installation

npm install --save @types/appdmg

Summary

This package contains type definitions for appdmg (https://github.com/LinusU/node-appdmg#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/appdmg.

index.d.ts

/// <reference types="node" />

declare namespace appdmg {
    interface Progress {
        current: number;
        total: number;
        type: "step-begin" | "step-end";
        title: string;
        status: "ok" | "skip" | "fail";
    }

    interface EventEmitter extends NodeJS.EventEmitter {
        on(event: "progress", listener: (info: Progress) => void): this;
        on(event: "finish", listener: () => void): this;
        on(event: "error", listener: (err: any) => void): this;
    }

    interface SpecificationOptions {
        app: string;
        background: string;
        icon: string;
        iconSize: number;
        title: string;
    }

    interface SpecificationWindow {
        position?: { x: number; y: number } | undefined;
        size?: { width: number; height: number } | undefined;
    }

    interface SpecificationContents {
        x: number;
        y: number;
        type: "link" | "file" | "position";
        path: string;
        name?: string | undefined;
    }

    interface SpecificationCodeSign {
        "signing-identity": string;
        identifier?: string | undefined;
    }

    interface Specification {
        title: string;
        icon?: string | undefined;
        background?: string | undefined;
        "background-color"?: string | undefined;
        "icon-size"?: number | undefined;
        window?: SpecificationWindow | undefined;
        format: "UDRW" | "UDRO" | "UDCO" | "UDZO" | "UDBZ" | "ULFO";
        contents: SpecificationContents[];
        "code-sign"?: SpecificationCodeSign | undefined;
    }

    interface Options {
        source?: string;
        target: string;
        basepath: string;
        specification: Specification;
    }
}

declare function appdmg(options?: appdmg.Options): appdmg.EventEmitter;

export = appdmg;

Additional Details

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

Credits

These definitions were written by Daniel Perez Alvarez.