# @types/appdmg

> TypeScript definitions for appdmg

Latest version **0.5.5** (published 2023-11-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/appdmg
pnpm add @types/appdmg
yarn add @types/appdmg
bun add @types/appdmg
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.5.5 |
| Published | 2023-11-06 |
| First published | 2017-12-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 6.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51438 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/appdmg
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/appdmg
- npm.io page: https://npm.io/package/@types/appdmg

## Dependencies (1)

- [@types/node](https://npm.io/package/@types/node.md) *

## Recent versions

- 0.5.5 (latest) — 2023-11-06
- 0.5.2 (ts3.6) — 2021-07-26
- 0.5.0 (ts2.0) — 2017-12-11
- 0.5.4 — 2023-10-17
- 0.5.3 — 2023-09-22
- 0.5.1 — 2021-07-07

## README

# 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](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/appdmg/index.d.ts)
````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](https://npmjs.com/package/@types/node)

# Credits
These definitions were written by [Daniel Perez Alvarez](https://github.com/unindented).

---
_Source: https://npm.io/package/@types/appdmg · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._