Skip to content

Commit 2c3fcde

Browse files
authored
chore: docs for quality and format (#157)
1 parent 3aa1b27 commit 2c3fcde

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/lib/types.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,14 +96,16 @@ export interface TransformOptions {
9696
*/
9797
resize?: 'cover' | 'contain' | 'fill'
9898
/**
99-
* Set the quality of the returned image, this is percentage based, default 80
99+
* Set the quality of the returned image.
100+
* A number from 20 to 100, with 100 being the highest quality.
101+
* Defaults to 80
100102
*/
101103
quality?: number
102104
/**
103105
* Specify the format of the image requested.
104106
*
105-
* When using 'origin' we force the format to be the same as the original image,
106-
* bypassing automatic browser optimisation such as webp conversion
107+
* When using 'origin' we force the format to be the same as the original image.
108+
* When this option is not passed in, images are optimized to modern image formats like Webp.
107109
*/
108110
format?: 'origin'
109111
}

0 commit comments

Comments
 (0)