Make Failover
Making failover images with a blink of an eye
A silent module based on ImageMagick for making failover images with specified properties.
API
await MakeFailover(output_path, width, height[, options])
output_path
Type: String
Output file path with extension (.jpg
, .png
, .gif
, .svg
, ...)
width
Type: Number
Image width, > 0
and <= 99999
pixels
height
Type: Number
Image height, > 0
and <= 99999
pixels
options.bin
Type: String
Default: ./bin/convert.exe
Path to convert.exe
file. This binary is not included, but you can download it from here.
options.quality
Type: Number
Default: 75
options.border_stroke
Type: Number
Default: 1
Border stroke size
options.border_color
Type: String
Default: #000000
options.bg_color
Type: String
Default: #ffffff
options.enable_macros
Type: Boolean
Default: false
Enable/disable replacing macros in output file name
Macros | Result |
---|---|
%width% |
300 |
%height% |
250 |
%size% |
300x250 |
%time% |
1537450293541 |
%uniq% |
jmam7jgr0r |
Usage
const path = require('path');
const MakeFailover = require('make-failover');
let width = 300;
let height = 250;
let output = path.join(__dirname, 'failover_%uniq%.jpg')
MakeFailover(width, height, output, {
enable_macros: true,
border_stroke: 20,
border_color: '#ff9900',
bg_color: '#00ffbb',
quality: 90
})
.then(result => {
// => C:/make-failover/failover_jmam7jgr0r.jpg
})
.catch(err => {})