# partyfy

> A Node.js library for generating rainbow party gifs

Latest version **0.1.9** (published 2021-07-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install partyfy
pnpm add partyfy
yarn add partyfy
bun add partyfy
```

Provides the command `partyfy`.

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.9 |
| Published | 2021-07-26 |
| First published | 2018-01-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 11.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 16 |
| Author | Dillon Mulroy |
| Maintainers | dmmulroy |

## Links

- npm: https://www.npmjs.com/package/partyfy
- Repository: https://github.com/dmmulroy/partyfy
- Homepage: https://github.com/dmmulroy/partyfy#readme
- Issues: https://github.com/dmmulroy/partyfy/issues
- npm.io page: https://npm.io/package/partyfy

## Dependencies (4)

- [gifwrap](https://npm.io/package/gifwrap.md) ^0.9.2
- [commander](https://npm.io/package/commander.md) ^3.0.2
- [file-type](https://npm.io/package/file-type.md) ^12.2.0
- [get-pixels](https://npm.io/package/get-pixels.md) ^3.3.2

## Recent versions

- 0.1.9 (latest) — 2021-07-26
- 0.1.8 — 2020-11-20
- 0.1.7 — 2020-04-05
- 0.1.6 — 2020-03-21
- 0.1.5 — 2020-03-21
- 0.1.4 — 2020-03-21
- 0.1.3 — 2020-03-20
- 0.1.2 — 2019-10-29
- 0.1.1 — 2019-10-29
- 0.1.0 — 2019-10-29
- 0.0.19 — 2019-10-16
- 0.0.18 — 2019-10-16
- 0.0.17 — 2019-09-08
- 0.0.16 — 2019-09-08
- 0.0.15 — 2019-08-28
- … 13 more at https://npm.io/package/partyfy/versions

## README

# partyfy

[![npm version](https://badge.fury.io/js/partyfy.svg)](https://badge.fury.io/js/partyfy)

## Usage

### `partyfy(file[, options])`

- file `<Buffer>`
- options `<Object>`
  - frameDelay `<number>` Speed in milliseconds between frames. Default: 75
  - overlayOpacity `<number>` Opacity of the overlayed party color (0 - 100). Default: 60

Returns `<Promise<Buffer>>`

## Example

### Before

![Before](https://i.imgur.com/vdzHTvI.png)

### After

![AFter](https://i.imgur.com/oIZtzvg.gif)

```javascript
const fs = require('fs');
const partyfy = require('partyfy');

(async () => {
  const image = fs.readFileSync('my-image.png');

  const partyImage = await partyfy(image);

  fs.writeFileSync('my-party-image.gif', partyImage);
})();
```

## npx/cli

`npx partyfy` or `npm i partyfy -G`

```
Usage: partyfy <source> <dest> [options]

A CLI for partyfy.

Options:
  -V, --version          output the version number
  -d, --delay <ms>       The Speed in milliseconds between frames. (default: 75)
  -o, --opacity <value>  Opacity of the overlayed party color (0 - 100). (default: 60)
  -h, --help             output usage information
```

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