Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ben-ng/resize-stream
Resize images from files, streams, and multipart forms
https://github.com/ben-ng/resize-stream
Last synced: 21 days ago
JSON representation
Resize images from files, streams, and multipart forms
- Host: GitHub
- URL: https://github.com/ben-ng/resize-stream
- Owner: ben-ng
- Created: 2013-11-10T23:55:55.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2013-11-11T05:21:39.000Z (almost 11 years ago)
- Last Synced: 2024-10-06T13:47:37.415Z (about 1 month ago)
- Language: JavaScript
- Size: 293 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
resize-stream
=============
[](https://travis-ci.org/ben-ng/resize-stream)
Resizing images can suck. This library hopes to make that better.
**Depends on ImageMagick, so make sure you have that installed**
```
var rstream = require('resize-stream');
// From a file path
rstream.resizeFile('cat.jpg'
, {width: 50, height: 50} // See options documentation for more
, function (err, outStream, contentLength) {
// outStream is a readable stream
// contentLength makes it easy to .pipe() to S3
});
// From a multipart form request
rstream.resizeReq(req
, {width: 50, height: 50}
, function (err, outStream, contentLength) {
// etc
});
// From a stream
rstream.resizeStream(fs.createReadStream('cat.jpg')
, {width: 50, height: 50}
, function (err, outStream, contentLength) {
// etc
});
```
Options
-------
The second parameter is always an optional options hash. See the examples below for a visual guide.
| Option Name | Default Value | Effect |
|:-----------:|:-------------:|:------------------------------------------------------------------:|
| width | 320px | The target width of the output image in pixels |
| height | 320px | The target height of the output image in pixels |
| fit | `false` | Fit the input image inside the bounds of the output image |
| crop | `true` | Crop the image instead of changing the aspect ratio or fitting |
| autoOrient | `true` | Rotate the image using its EXIF data |
Fit and Crop Examples
---------------------
Since these are hard to explain in words, here are some visual examples.
### 450x450 Original
[Credit](https://pusheen.com)
| Target Dimensions | Crop | Fit | Result | Output Dimensions|
|:-----------------:|:-----:|:-----:|:---------------------------------------------------------------------------------------------------------------------------:|:----------------:|
| 200x400px |`true` |Ignored| | 200x400px |
| 200x400px |`false`|`false`|| 200x400px |
| 200x400px |`false`|`true` | | 200x200px |
To-Do
-----
* Stream API kind of stinks, we should be a duplex stream.
* Finer control over the imagemagick commands
License
-------
The MIT License (MIT)
Copyright (c) 2013 Ben Ng
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.