# collage-maker

> Make collages

Latest version **1.1.5** (published 2021-06-01) · ISC license · 0 weekly downloads

## Install

```sh
npm install collage-maker
pnpm add collage-maker
yarn add collage-maker
bun add collage-maker
```

## 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.1.5 |
| Published | 2021-06-01 |
| First published | 2021-05-01 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Hani Orbit |
| Maintainers | brightgowon |

## Links

- npm: https://www.npmjs.com/package/collage-maker
- npm.io page: https://npm.io/package/collage-maker

## Dependencies (1)

- [jimp](https://npm.io/package/jimp.md) ^0.16.1

## Recent versions

- 1.1.5 (latest) — 2021-06-01
- 1.0.5 — 2021-05-06
- 1.0.4 — 2021-05-01
- 1.1.0 — 2021-05-01
- 1.0.3 — 2021-05-01
- 1.0.2 — 2021-05-01
- 1.0.1 — 2021-05-01
- 1.0.0 — 2021-05-01

## README

setRandom: (opc: boolean) => void

    Choose if the execution should generate a random query of the sample images to fill all final image size. 
    By default it's false.
    The function with no return.

setFinalPath: (path: string) => void

    Set the path to write the image in the disk, should be a string like this example: './final/final.jpg' | './output.png'.
    By default it's './final/final.jpg'.
    The function with no return.

setWorkPath: (path: string) => void

    Set the path to safety works on the images, should be a string like this examples: './active/act.jpg' | './workInProgress.png'.
    By default it's './active/clone.jpg'.
    The function with no return.

setCanvas: (path: string) => void

    Set the path to the canvas of the images, should be a string like this examples: './raw/back.jpg' | './canvas.png'.
    By default it's './raw/background.jpg'.
    The function with no return.

setBorder: (size: number) => void

    Set the border size on the output image.
    By default it's 30.
    The function with no return.

setBorderAround: (size: number, color: string) => void

    Set color and size of the border around each image, color should be a string of a hex or RGB color.
    By default size = 0 and color = '#FF00FF'.
    The function with no return.

setGrid: (col: number, row: number) => void

    Set the column and row numbers in the collage.
    By default, both columns and rows are 0.
    The function with no return.

setSamples: (sam: any) => void

    Set the samples path to use on collage, should be a array of strings which could be either an direct file path on your computer or an HTTP link.
    By default the array it's empty.
    The function with no return.

adjustToSamples: (w: number, h: number) => void

    Adjust canvas size to fit all the samples.
    You don't need to call this method all the time, just if you need to ensure the canvas gonna fit all the samples perfectly.
    The function with no return.

execute: () => Promise<any>

    Execute the methods to make the output image, then save the image on a disk or database.
    Use this method only when you've set all the params that you wanted on your output image.
    The function returns a promise with 0 if rejected or the output path if resolved.

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