Skip to content

Commit

Permalink
docs(imagetransformer): added missing documentation to ImageTransform…
Browse files Browse the repository at this point in the history
…er methods
  • Loading branch information
Josh-McFarlin committed Jun 24, 2022
1 parent 687369e commit 4315436
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
8 changes: 7 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down
13 changes: 12 additions & 1 deletion src/imageTransformer/imageTransformer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 4315436

Please sign in to comment.