picmerge

1.0.0 • Public • Published

PicMerge

A simple tool that merges two images and return a url where the final image has been uploaded to.

Usage

Using PicMerge is pretty simple.

Fair warning PicMerge is written entirely in ES6. So please make sure you're transpiling your Javascript code somewhere in your build process.

1. Install PicMerge

Run npm install picmerge --save, or if you're cool, use yarn. yarn add picmerge

2. Import picMerge into your nodeJS app

 
const picMerge = require('picmerge');
 

If the name doesn't suit your context, you may do something like...

 
const kudiReferralImg = require('picmerge');
 

3. Use PicMerge

This is the fun part.

picMerge(firstImageURL, secondImageURL)
.then(url => {
    //do anything with the url here
    console.log(url);
})

If no exceptions are thrown, the url variable would hold a string representation of the URL for the merged picture.

4. Playing Safe

Because shit happens, you may want to do this:

picMerge(firstImageURL, secondImageURL)
.then(url => {
    //do anything with the url here
    console.log(url);
})
.catch(err => {
    //handle err
})

This would save you from events in which an error occurs while picMerge does it's magic.

Later, you may be able to pass in a default url to the picMerge function. So, in the event that an error occurs, picMerge would return the url for some default Image you have specified.

Something like:

    const mergedPicsURL = picMerge(firstImageURL, secondImageURL, defaultImageURL)

5. Example

Here are two urls.

    const bgImg = 'http://i.imgur.com/7mb8Bcl.png';
    const profilePic = 'http://i.imgur.com/sMayycp.png';
 

Below is the Background Image:

BG image

And the Profile Picture:

Profile Pics

Update your code:

    const bgImg = 'http://i.imgur.com/7mb8Bcl.png';
    const profilePic = 'http://i.imgur.com/sMayycp.png';
 
    const picMerge = require('./picMerge');
    picMerge(bgImg, profilePic)
    .then(url => {
        console.log(url)
    })

when the picMerge promise is fufilled, res is http://res.cloudinary.com/blushcow/image/upload/v1490510074/vyh2qan9awf6whoidasp.jpg

Final Image

6. What else?

Well, nothing else for now.

Dependents (0)

Package Sidebar

Install

npm i picmerge

Weekly Downloads

0

Version

1.0.0

License

ISC

Last publish

Collaborators

  • ohansemmanuel