Docs refresh

This commit is contained in:
Lovell Fuller 2017-05-22 21:49:37 +01:00
parent 4c6804eadc
commit d6a63d11d7
4 changed files with 17 additions and 6 deletions

View File

@ -24,7 +24,10 @@
Rotate the output image by either an explicit angle
or auto-orient based on the EXIF `Orientation` tag.
Use this method without angle to determine the angle from EXIF data.
If an angle is provided, it is converted to a valid 90/180/270deg rotation.
For example, `-450` will produce a 270deg rotation.
If no angle is provided, it is determined from the EXIF data.
Mirroring is supported and may infer the use of a flip operation.
The use of `rotate` implies the removal of the EXIF `Orientation` tag, if any.
@ -34,7 +37,7 @@ for example `rotate(x).extract(y)` will produce a different result to `extract(y
**Parameters**
- `angle` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** 0, 90, 180 or 270. (optional, default `auto`)
- `angle` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** angle of rotation, must be a multiple of 90. (optional, default `auto`)
**Examples**

View File

@ -49,6 +49,14 @@ Requires libvips v8.5.5.
[#783](https://github.com/lovell/sharp/pull/783)
[@YvesBos](https://github.com/YvesBos)
* Add support for rotation using any multiple of +/-90 degrees.
[#791](https://github.com/lovell/sharp/pull/791)
[@ncoden](https://github.com/ncoden)
* Add "jpg" alias to toFormat as shortened form of "jpeg".
[#814](https://github.com/lovell/sharp/pull/814)
[@jingsam](https://github.com/jingsam)
### v0.17 - "*quill*"
Requires libvips v8.4.2.

View File

@ -9,7 +9,7 @@ const is = require('./is');
* If an angle is provided, it is converted to a valid 90/180/270deg rotation.
* For example, `-450` will produce a 270deg rotation.
*
* If no angle is provided, it is determined the from EXIF data.
* If no angle is provided, it is determined from the EXIF data.
* Mirroring is supported and may infer the use of a flip operation.
*
* The use of `rotate` implies the removal of the EXIF `Orientation` tag, if any.

View File

@ -75,14 +75,14 @@
"tar": "^3.1.3"
},
"devDependencies": {
"async": "^2.4.0",
"cc": "^1.0.0",
"async": "^2.4.1",
"cc": "^1.0.1",
"documentation": "^4.0.0-rc.1",
"exif-reader": "^1.0.2",
"icc": "^1.0.0",
"mocha": "^3.4.1",
"nyc": "^10.3.2",
"rimraf": "^2.5.4",
"rimraf": "^2.6.1",
"semistandard": "^11.0.0",
"unzip": "^0.1.11"
},