YUBIGEN
Node Thumbnail generation without limits
Prerequisites
Please refer to the operating system-specific instructions on installing the following before using YUBIGEN.
- both
graphicsmagick
and imagemagick
npm
and node
gm
package for npm
. If npm
has been installed, simply run npm install gm
.aws-sdk
package for npm
, but only if putting objects to AWS S3
Description of Implementation
YUBIGEN makes use of the resize
and crop
functions found in gm
to resize and crop images according to specified parameters, respectively passed into the resizeParams
and cropParams
fields in the second parameter object in arrays. The third parameter is passed a callback which handles the resulting buffer in the specified manner.
YUBIGEN also has a way to predict the format of the input, as well as a function
to output to a specified file and to upload to an AWS S3 Bucket.
Format-specific functions have been made available as well.
Methods
yubigen.fromUrl(url, paramObj, callback)
Manipulates image given URL
yubigen.fromFile(path, paramObj, callback)
Manipulates image from file given path
yubigen.fromBuffer(buffer, paramObj, callback)
Manipulates image from a buffer given path
yubigen.predict(input, paramObj, callback)
Predicts format (string or buffer) of the given input
yubigen.outToFile(outFile, input, paramObj, callback)
Outputs to file as specified from input format prediction
yubigen.s3Put(config, bucket, path, input, paramObj, callback)
With specified credentials (default if config
is null
), outputs to specified S3 Bucket as specified from
input format prediction (requires external install of aws-sdk
package)
Parameter Object Keys
resizeParams
: resize parameters as specified by resize
in a one-dimensional arraycropParams
: crop parameters as specified by crop
in a one-dimensional arrayformat
: file formatimageMagick
: ImageMagick enabled if true
Callback
result
: resulting buffererr
: error if any
Usage
const yubigen = require('yubigen'), fs = require('fs'),
AWS = require('aws-sdk');
var params = {
resizeParams: [100],
cropParams: [50,50,20,0],
format: "JPEG",
imageMagick: false
}, writeFile = (result, err) => {
fs.writeFile("bruh.png", result, (error) => {
if (error) console.log(error);
});
}, s3_upload = (result, err) => {
var args = {
Bucket: BUCKET_NAME
Key: KEY_NAME,
Body: result
}, var s3 = new AWS.S3();
s3.putObject(args, function(error) {
if (error) console.log(error);
});
};
yubigen.fromUrl("https://ktuh.org/img/ktuh-fm-logo.png", params, writeFile);
yubigen.fromFile("bruh.png", params, s3_upload);
fs.readFile('alpha.jpg', function(error, data) {
yubigen.fromBuffer(data, params, (result, err) => {
fs.writeFile("gamma.png", result, (error) => {
if (error) console.log(error);
});
});
});
yubigen.outToFile('logo.png', "https://ktuh.org/img/ktuh-fm-logo.png", params,
(result, err) => {
if (error) console.log(error);
else console.log(result);
});
fs.readFile('test/images/alpha.jpg', function(error, data) {
yubigen.s3Put(null, "my-bucket", "alpha.png", data, params,
(result, err) => {
if (error) console.log(error);
else if (result) console.log("Upload success!");
});
});
Author
Contributors
- Pull requests and issues are welcome! Feature requests will be considered on
a case-by-case basis.