@jimp/plugin-contain - npm Package Compare versions

Comparing version 0.3.7 to 0.3.8

package.json

		{
		"name": "@jimp/plugin-contain",
		"version": "0.3.7",
		"version": "0.3.8",
		"description": "contain an image.",
		@@ -19,3 +19,3 @@ "main": "dist/index.js",
		"dependencies": {
		"@jimp/utils": "^0.3.7"
		"@jimp/utils": "^0.3.8"
		},
		@@ -30,3 +30,4 @@ "peerDependencies": {
		"access": "public"
		}
		},
		"gitHead": "e04f0bb3d755b18136b00ccefc02497b7581a828"
		}

README.md

		@@ -1,3 +0,30 @@
		# @jimp/plugin-contain
		<div align="center">
		<a href="https://intuit.github.io/Ignite/">
		<img width="200" height="200"
		src="https://s3.amazonaws.com/pix.iemoji.com/images/emoji/apple/ios-11/256/crayon.png">
		</a>
		<h1>@jimp/plugin-contain</h1>
		<p>Contain an image within a height and width.</p>
		</div>

		contain an image.
		Scale the image to the given width and height keeping the aspect ratio. Some parts of the image may be letter boxed.

		## Usage

		- @param {number} w the width to resize the image to
		- @param {number} h the height to resize the image to
		- @param {number} alignBits (optional) A bitmask for horizontal and vertical alignment
		- @param {string} mode (optional) a scaling method (e.g. Jimp.RESIZE_BEZIER)
		- @param {function(Error, Jimp)} cb (optional) a callback for when complete

		```js
		import jimp from 'jimp';

		async function main() {
		const image = await jimp.read('test/image.png');

		image.contain(150, 100);
		}

		main();
		```

New alerts