combine-image-typescript
v1.0.4
Published
Combine multiple images into a single image
Downloads
3
Maintainers
Readme
combine-image
This project is not actively developed. Please feel free to fork or add changes as per the requirements.
Combine multiple images into a single image
combine-image-typescript
combines given images into a single image in right order. This will be helpful in a situation when you have to generate a preview of multiple images into a single image. This module is based on [Jimp
] for image processing and is based on combine-images
but converted to typescript and uses much newer versions of libraries
Install
$ npm install combine-image-typescript
$ yarn add combine-image-typescript
$ pnpm install combine-image-typescript
Usage
import combineImage from 'combine-image';
combineImage(['image-1.png', 'image-2.jpg'])
.then((img) => {
// Save image as file
img.write('out.png', () => console.log('done'));
});
API
combineImage(images[, options])
images
Array of (String | Object | Buffer | [Jimp]) - List of images to concat. IfString
is passed, it will be considered to the file path. Also you can pass other [Jimp] object. AnObject
entry can have following options:src
String
orBuffer
- A single image source to concat.offsetX
Number (optional) -x
offset to affect this image. Default is0
.offsetY
Number (optional) -y
offset to affect this image. Default is0
.
options
Object (optional)direction
String - Direction of the merged image. If this value iscol
, the images will be merged vertically (col). Otherwise, If this value isrow
the images will be merged horizontally (row). Default iscol
.color
Number (hex) - Default background color represented by RGBA hex value. Default is0x00000000
.offset
Number - Offset in pixels between each image. Default is0
.margin
(Number | String | Object) - Margin of the result image. IfNumber
orString
is passed, it will be considered as standard css shorthand properties (e.g. '40 40 0 10'). AnObject
entry can have following options:top
Number (optional) - Margin on top side of result image. Default is0
.right
Number (optional) - Margin on right side of result image. Default is0
.bottom
Number (optional) - Margin on bottom side of result image. Default is0
.left
Number (optional) - Margin on left side of result image. Default is0
.
Returns a Promise
that contains [Jimp
] object.