Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dchan3/yubigen
Node Thumbnail generation without limits
https://github.com/dchan3/yubigen
graphicsmagick image-manipulation image-processing imagemagick node node-js npm thumbnail thumbnail-generator thumbnail-images
Last synced: 27 days ago
JSON representation
Node Thumbnail generation without limits
- Host: GitHub
- URL: https://github.com/dchan3/yubigen
- Owner: dchan3
- Created: 2018-03-20T04:34:23.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-06-09T14:39:27.000Z (over 6 years ago)
- Last Synced: 2024-09-29T18:03:56.452Z (about 1 month ago)
- Topics: graphicsmagick, image-manipulation, image-processing, imagemagick, node, node-js, npm, thumbnail, thumbnail-generator, thumbnail-images
- Language: JavaScript
- Homepage: https://dchan3.github.io/yubigen
- Size: 574 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
Awesome Lists containing this project
README
# YUBIGEN
Node Thumbnail generation without limits
[](https://www.npmjs.com/package/yubigen)
[](https://travis-ci.org/dchan3/yubigen)
## 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`, installed at the application level, but only if putting objects to AWS S3
## Description of Implementation
YUBIGEN makes use of the [`resize`](http://aheckmann.github.io/gm/docs.html#resize) and [`crop`](http://aheckmann.github.io/gm/docs.html#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`](http://aheckmann.github.io/gm/docs.html#resize) in a one-dimensional array
- `cropParams`: crop parameters as specified by [`crop`](http://aheckmann.github.io/gm/docs.html#crop) in a one-dimensional array
- `textParams`: an array of text parameter objects. Text parameter object schema is as follows.
- `fontName`: name of font to use, passed into [`font`](http://aheckmann.github.io/gm/docs.html#font)
- `fontSize`: text font size, passed into [`fontSize`](http://aheckmann.github.io/gm/docs.html#fontSize)
- `color`: text fill color, passed into [`fill`](http://aheckmann.github.io/gm/docs.html#fill)
- `drawParams`: text draw parameters as specified by [`drawText`](http://aheckmann.github.io/gm/docs.html#drawText) in a one-dimensional array
- `format`: file format
- `imageMagick`: ImageMagick enabled if true
## Callback
- `result`: resulting buffer
- `err`: error if any
## Usage
```js
const yubigen = require('yubigen'), fs = require('fs'),
AWS = require('aws-sdk'); // for demonstration purposes
var params = {
resizeParams: [100], // resize parameters as specified by gm resize
cropParams: [50,50,20,0], // crop parameters as specified by gm crop
format: "JPEG", // file format
imageMagick: false, // ImageMagick not enabled
textParams: [ // Text parameter object #1:
{
color: "#5940de",
fontSize: "24pt",
drawParams: [0, 0, "CENSORED", "Center"] // text draw parameters as specified by gm drawText
},
{
color: "#000000",
fontSize: "12pt",
drawParams: [0, 0, "VOID", "Center"]
}
]
}, writeFile = (result, err) => { // write to file callback
fs.writeFile("bruh.png", result, (error) => {
if (error) console.log(error);
});
}, s3_upload = (result, err) => {
// callback to upload to S3 Bucket, for demonstration purposes
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);
});
};
// From URL
yubigen.fromUrl("https://ktuh.org/img/ktuh-fm-logo.png", params, writeFile);
// From file
yubigen.fromFile("bruh.png", params, s3_upload);
// From buffer
fs.readFile('alpha.jpg', function(error, data) {
yubigen.fromBuffer(data, params, (result, err) => {
fs.writeFile("gamma.png", result, (error) => {
if (error) console.log(error);
});
});
});
// Export from URL to file
yubigen.outToFile('logo.png', "https://ktuh.org/img/ktuh-fm-logo.png", params,
(result, err) => {
if (error) console.log(error);
else console.log(result);
});
// Put Object to S3 bucket `my-bucket` with default AWS credentials
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
- Derek Chan
## Contributors
- Pull requests and issues are welcome! Feature requests will be considered on
a case-by-case basis.