@types/sharp
Advanced tools
@types/sharp - npm Package Compare versions
Comparing version 0.17.0 to 0.17.1
@@ -22,3 +22,5 @@ // Type definitions for sharp 0.17 | ||
| /** | ||
| * Gets, or when options are provided sets, the limits of libvips' operation cache. Existing entries in the cache will be trimmed after any change in limits. This method always returns cache statistics, useful for determining how much working memory is required for a particular task. | ||
| * Gets, or when options are provided sets, the limits of libvips' operation cache. | ||
| * Existing entries in the cache will be trimmed after any change in limits. | ||
| * This method always returns cache statistics, useful for determining how much working memory is required for a particular task. | ||
| * @param {boolean|sharp.CacheOptions} options Object with the cache options, or Boolean where true uses default cache settings and false removes all caching. | ||
@@ -225,3 +227,8 @@ * @returns {Object} | ||
| * Alternative spelling of greyscale. | ||
| * Convert to 8-bit greyscale; 256 shades of grey. This is a linear operation. If the input image is in a non-linear colour space such as sRGB, use gamma() with greyscale() for the best results. By default the output image will be web-friendly sRGB and contain three (identical) color channels. This may be overridden by other sharp operations such as toColourspace('b-w'), which will produce an output image containing one color channel. An alpha channel may be present, and will be unchanged by the operation. | ||
| * Convert to 8-bit greyscale; 256 shades of grey. | ||
| * This is a linear operation. | ||
| * If the input image is in a non-linear colour space such as sRGB, use gamma() with greyscale() for the best results. | ||
| * By default the output image will be web-friendly sRGB and contain three (identical) color channels. | ||
| * This may be overridden by other sharp operations such as toColourspace('b-w'), which will produce an output image containing one color channel. | ||
| * An alpha channel may be present, and will be unchanged by the operation. | ||
| * @param {boolean} grayscale true to enable and false to disable (defaults to true) | ||
@@ -232,3 +239,8 @@ * @returns {SharpInstance} A sharp instance that can be used to chain operations | ||
| /** | ||
| * Convert to 8-bit greyscale; 256 shades of grey. This is a linear operation. If the input image is in a non-linear colour space such as sRGB, use gamma() with greyscale() for the best results. By default the output image will be web-friendly sRGB and contain three (identical) color channels. This may be overridden by other sharp operations such as toColourspace('b-w'), which will produce an output image containing one color channel. An alpha channel may be present, and will be unchanged by the operation. | ||
| * Convert to 8-bit greyscale; 256 shades of grey. | ||
| * This is a linear operation. | ||
| * If the input image is in a non-linear colour space such as sRGB, use gamma() with greyscale() for the best results. | ||
| * By default the output image will be web-friendly sRGB and contain three (identical) color channels. | ||
| * This may be overridden by other sharp operations such as toColourspace('b-w'), which will produce an output image containing one color channel. | ||
| * An alpha channel may be present, and will be unchanged by the operation. | ||
| * @param {boolean} greyscale true to enable and false to disable (defaults to true) | ||
@@ -319,3 +331,7 @@ * @returns {SharpInstance} A sharp instance that can be used to chain operations | ||
| * Write output to a Buffer. JPEG, PNG, WebP, and RAW output are supported. By default, the format will match the input image, except GIF and SVG input which become PNG output. | ||
| * @param {Function} callback Callback function called on completion with three arguments (err, buffer, info). err is an error message, if any. buffer is the output image data. info contains the output image format, size (bytes), width, height and channels. A Promises/A+ promise is returned when callback is not provided. | ||
| * @param {Function} callback Callback function called on completion with three arguments (err, buffer, info). | ||
| * err is an error message, if any. | ||
| * buffer is the output image data. | ||
| * info contains the output image format, size (bytes), width, height and channels. | ||
| * A Promises/A+ promise is returned when callback is not provided. | ||
| * @returns {SharpInstance} A sharp instance that can be used to chain operations | ||
@@ -371,3 +387,5 @@ */ | ||
| /** | ||
| * Include all metadata (EXIF, XMP, IPTC) from the input image in the output image. The default behaviour, when withMetadata is not used, is to strip all metadata and convert to the device-independent sRGB colour space. This will also convert to and add a web-friendly sRGB ICC profile. | ||
| * Include all metadata (EXIF, XMP, IPTC) from the input image in the output image. | ||
| * The default behaviour, when withMetadata is not used, is to strip all metadata and convert to the device-independent sRGB colour space. | ||
| * This will also convert to and add a web-friendly sRGB ICC profile. | ||
| * @param {Metadata} | ||
@@ -378,3 +396,4 @@ * @throws {Error} Invalid parameters. | ||
| /** | ||
| * Use tile-based deep zoom (image pyramid) output. Set the format and options for tile images via the toFormat, jpeg, png or webp functions. Use a .zip or .szi file extension with toFile to write to a compressed archive file format. | ||
| * Use tile-based deep zoom (image pyramid) output. Set the format and options for tile images via the toFormat, jpeg, png or webp functions. | ||
| * Use a .zip or .szi file extension with toFile to write to a compressed archive file format. | ||
| * @param {TileOptions} options options | ||
@@ -381,0 +400,0 @@ */ |
| { | ||
| "name": "@types/sharp", | ||
| "version": "0.17.0", | ||
| "version": "0.17.1", | ||
| "description": "TypeScript definitions for sharp", | ||
| "license": "MIT", | ||
| "author": "François Nguyen <https://github.com/lith-light-g>", | ||
| "contributors": [ | ||
| { | ||
| "name": "François Nguyen", | ||
| "url": "https://github.com/lith-light-g" | ||
| } | ||
| ], | ||
| "main": "", | ||
@@ -17,4 +22,4 @@ "repository": { | ||
| "peerDependencies": {}, | ||
| "typesPublisherContentHash": "cd9fb2911b697b0bb5c5dd898426343b1a7a283f7d9fbab88b746cb850273a59", | ||
| "typesPublisherContentHash": "39c6e02445c7a8696c5862458944ff667211c4a122ac4e4445ab55ca115c861b", | ||
| "typeScriptVersion": "2.0" | ||
| } |
@@ -11,3 +11,3 @@ # Installation | ||
| Additional Details | ||
| * Last updated: Sat, 28 Jan 2017 00:32:33 GMT | ||
| * Last updated: Thu, 23 Feb 2017 18:39:27 GMT | ||
| * Dependencies: stream, node | ||
@@ -14,0 +14,0 @@ * Global values: none |
@@ -6,3 +6,8 @@ { | ||
| "data": { | ||
| "authors": "François Nguyen <https://github.com/lith-light-g>", | ||
| "contributors": [ | ||
| { | ||
| "name": "François Nguyen", | ||
| "url": "https://github.com/lith-light-g" | ||
| } | ||
| ], | ||
| "dependencies": { | ||
@@ -28,5 +33,5 @@ "stream": "*", | ||
| "hasPackageJson": false, | ||
| "contentHash": "cd9fb2911b697b0bb5c5dd898426343b1a7a283f7d9fbab88b746cb850273a59" | ||
| "contentHash": "39c6e02445c7a8696c5862458944ff667211c4a122ac4e4445ab55ca115c861b" | ||
| }, | ||
| "isLatest": true | ||
| } |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by1.44%
34829
- Lines of code
- increased by3.31%
656
No dependency changes