dpi-tools
Version:
Quickly change the dpi for an image without re-enconding
75 lines (52 loc) • 1.85 kB
Markdown
# dpi-tools
dpi-tools provides 2 utility functions that can change the dpi of canvas-generated image, of either dataUrl or blob formats. The functions separate the header from the image data, convert and manipulate just the header, then sticks the header back on the file. In this way, very large images can be converted quickly without having to convert the entire contents of an image file. This process is non-destructive—image data does not get modified in the process.
This package is forked from [shutterstock/changeDPI](https://github.com/shutterstock/changeDPI) in an attempt to modernize the build process using [rollup](https://github.com/rollup/rollup) and hopefully implement some new features!
## Install
```shell
npm install --save dpi-tools
```
## Import
```
/* ES6 */
import dpiTools from 'dpi-tools';
import { changeDpiDataUrl, changeDpiBlob } from 'dpi-tools';
```
```
/* ES5 */
var dpiTools = require('dpi-tools');
```
## Usage
From a canvas element dataUrl:
```js
// create the dataUrl at standard 72dpi
var dataUrl = canvas.toDataURL('image/jpeg', 0.92);
var daurl150dpi = changeDpiDataUrl(dataUrl, 150);
```
From a canvas element blob:
```js
// create the blob at standard 72dpi
canvas.toBlob(
function (blob) {
changeDpiBlob(blob, 300).then(function (blob) {
// use your changed blob
});
},
'image/jpeg',
0.92
);
```
```js
TODO add example with file reader.
```
### ES6
This module uses ES6. To see a compiled ES5 version, run `npm run build` and look in `dist/`.
## Testing
```js
npm install
npm run test
```
## Contribute
Please do contribute! Open an issue or submit a pull request.
The project falls under [@Shutterstock](https://github.com/shutterstock/welcome)'s [Code of Conduct](https://github.com/shutterstock/welcome/blob/master/CODE_OF_CONDUCT.md).
## License
MIT.