diff --git a/CHANGELOG.md b/CHANGELOG.md index 0618540..7611252 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [Unreleased] + +### Docs + +- Added missing documentation to `ImageTransformer` methods + ## [1.0.0] - 2022-06-24 ### Breaking @@ -13,7 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added - Implemented `fit` and `position` when resizing images -- Created a `ImageTransformer` class that uses methods for apply image operations +- Created a `ImageTransformer` class that uses methods for applying image operations ### Fixed diff --git a/src/imageTransformer/imageTransformer.ts b/src/imageTransformer/imageTransformer.ts index cbe0bb7..1709389 100644 --- a/src/imageTransformer/imageTransformer.ts +++ b/src/imageTransformer/imageTransformer.ts @@ -131,15 +131,26 @@ export default class ImageTransformer { /** * Resize the image. * @param width Width of resulting image or null. - * @param height Height of resulting image or null. If width is present, this takes priority. (optional, default null) * @param options Optional settings used to adjust the fit and placement of the image within its frame. */ resize(width: number, options?: ResizeOptions): ImageTransformer; + /** + * Resize the image. + * @param width Width of resulting image or null. + * @param height Height of resulting image or null. If width is present, this takes priority. (optional, default null) + * @param options Optional settings used to adjust the fit and placement of the image within its frame. + */ resize( width: null, height: number, options?: ResizeOptions ): ImageTransformer; + /** + * Resize the image. + * @param width Width of resulting image or null. + * @param height Height of resulting image or null. If width is present, this takes priority. (optional, default null) + * @param options Optional settings used to adjust the fit and placement of the image within its frame. + */ resize( width: number, height: number,