michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

@astrojs/image: Allow passing undefined to transform options (#6008)

Browse source 
* Allow passing `undefined` to transform options

This fixes #6001, allowing undefined passed as a variable in addition to not passing the property at all

* Create strange-olives-rest.md

* Improve error message for missing `widths` prop

* Add changeset
This commit is contained in:
Caleb Jasik 2023-01-27 11:05:00 -06:00 committed by GitHub
parent b994f6f35e
commit 9c298aa5ae
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 19 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/polite-wombats-play.md Normal file
View file

@ -0,0 +1,5 @@
---
'@astrojs/image': patch
---
Updated error message for missing `widths` prop to provide an example

5
.changeset/strange-olives-rest.md Normal file
View file

@ -0,0 +1,5 @@
---
"@astrojs/image": patch
---
Allow passing `undefined` to TransformOptions, this is a types fix for users with `exactOptionalTypes` enabled in their tsconfig

2
packages/integrations/image/src/lib/get-picture.ts
View file

@ -51,7 +51,7 @@ export async function getPicture(params: GetPictureParams): Promise<GetPictureRe
}
if (!widths || !Array.isArray(widths)) {
throw new Error('[@astrojs/image] at least one `width` is required');
throw new Error('[@astrojs/image] at least one `width` is required. ex: `widths={[100]}`');
}
const aspectRatio = await resolveAspectRatio(params);

16
packages/integrations/image/src/loaders/index.ts
View file

@ -98,23 +98,23 @@ export interface TransformOptions {
*
* @default undefined The original image format will be used.
*/
format?: OutputFormat;
format?: OutputFormat | undefined;
/**
* The compression quality used during optimization.
*
* @default undefined Allows the image service to determine defaults.
*/
quality?: number;
quality?: number | undefined;
/**
* The desired width of the output image. Combine with `height` to crop the image
* to an exact size, or `aspectRatio` to automatically calculate and crop the height.
*/
width?: number;
width?: number | undefined;
/**
* The desired height of the output image. Combine with `height` to crop the image
* to an exact size, or `aspectRatio` to automatically calculate and crop the width.
*/
height?: number;
height?: number | undefined;
/**
* The desired aspect ratio of the output image. Combine with either `width` or `height`
* to automatically calculate and crop the other dimension.
@ -122,7 +122,7 @@ export interface TransformOptions {
* @example 1.777 - numbers can be used for computed ratios, useful for doing `{width/height}`
* @example "16:9" - strings can be used in the format of `{ratioWidth}:{ratioHeight}`.
*/
aspectRatio?: number | `${number}:${number}`;
aspectRatio?: number | `${number}:${number}` | undefined;
/**
* The background color to use when converting from a transparent image format to a
* non-transparent format. This is useful for converting PNGs to JPEGs.
@ -131,19 +131,19 @@ export interface TransformOptions {
* @example "#ffffff" - a hex color
* @example "rgb(255, 255, 255)" - an rgb color
*/
background?: ColorDefinition;
background?: ColorDefinition | undefined;
/**
* How the image should be resized to fit both `height` and `width`.
*
* @default 'cover'
*/
fit?: CropFit;
fit?: CropFit | undefined;
/**
* Position of the crop when fit is `cover` or `contain`.
*
* @default 'centre'
*/
position?: CropPosition;
position?: CropPosition | undefined;
}
export interface HostedImageService<T extends TransformOptions = TransformOptions> {