# apng-assembler

> Simple wrapper around the apngasm command line binary.

Latest version **1.0.2** (published 2017-12-13) · Zlib license · 0 weekly downloads

## Install

```sh
npm install apng-assembler
pnpm add apng-assembler
yarn add apng-assembler
bun add apng-assembler
```

Provides the command `apng`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2017-12-13 |
| First published | 2017-12-08 |
| Weekly downloads | 0 |
| License | Zlib |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Geoff Garbers |
| Maintainers | garbetjie |
| Keywords | apng, assembler, apngasm |

## Links

- npm: https://www.npmjs.com/package/apng-assembler
- Repository: https://github.com/garbetjie/apng-assembler
- Homepage: https://github.com/garbetjie/apng-assembler#readme
- Issues: https://github.com/garbetjie/apng-assembler/issues
- npm.io page: https://npm.io/package/apng-assembler

## Dependencies (2)

- [promise](https://npm.io/package/promise.md) ^8.0.1
- [argparse](https://npm.io/package/argparse.md) ^1.0.9

## Recent versions

- 1.0.2 (latest) — 2017-12-13
- 1.0.1 — 2017-12-08
- 1.0.0 — 2017-12-08

## README

APNG Assembler
--------------

Simple wrapper around the excellent [APNG Assembler](https://sourceforge.net/projects/apngasm) command line binary.


## Usage

```js
const Assembler = require('apng-assembler');

// Assemble file asynchronously.
Assembler.assemble(
    'input*.png',
    'output.png',
    {
        loopCount: 0,
        frameDelay: 100,
        compression: Assembler.COMPRESS_7ZIP
    }
).then(
    function(outputFile) {
        console.log(`${outputFile} has been assembled successfully.`);
    },
    function(error) {
        console.error(`Failed to assemble: ${error.message}`);
        console.error(`stdout: ${error.stdout}`);
        console.error(`stderr: ${error.stderr}`);
    }
);

// Assemble file synchronously.
try {
    Assembler.assembleSync(
        'input*.png',
        'output.png',
        {
            loopCount: 0,
            frameDelay: 100,
            compression: Assembler.COMPRESS_7ZIP
        }
    );
} catch (e) {
    console.error(`Failed to assemble: ${error.message}`);
    console.error(`stdout: ${error.stdout}`);
    console.error(`stderr: ${error.stderr}`);
}

// Pass an instance of the assembler around.
let assembler = new Assembler.Assembler(loopCount, frameDelay, compression);
assembler.assemble('input*.png', 'output.png');
assembler.assembleSync('input*.png', 'output.png');
```


## Credits

* [APNG Assembler](https://sourceforge.net/projects/apngasm) by Max Stepin.

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