diff options
| -rw-r--r-- | .changeset/polite-wombats-play.md | 5 | ||||
| -rw-r--r-- | .changeset/strange-olives-rest.md | 5 | ||||
| -rw-r--r-- | packages/integrations/image/src/lib/get-picture.ts | 2 | ||||
| -rw-r--r-- | packages/integrations/image/src/loaders/index.ts | 16 |
4 files changed, 19 insertions, 9 deletions
diff --git a/.changeset/polite-wombats-play.md b/.changeset/polite-wombats-play.md new file mode 100644 index 000000000..fac2ca632 --- /dev/null +++ b/.changeset/polite-wombats-play.md @@ -0,0 +1,5 @@ +--- +'@astrojs/image': patch +--- + +Updated error message for missing `widths` prop to provide an example diff --git a/.changeset/strange-olives-rest.md b/.changeset/strange-olives-rest.md new file mode 100644 index 000000000..d183c93cf --- /dev/null +++ b/.changeset/strange-olives-rest.md @@ -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 diff --git a/packages/integrations/image/src/lib/get-picture.ts b/packages/integrations/image/src/lib/get-picture.ts index 37fea6de4..2ecfc0d5b 100644 --- a/packages/integrations/image/src/lib/get-picture.ts +++ b/packages/integrations/image/src/lib/get-picture.ts @@ -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); diff --git a/packages/integrations/image/src/loaders/index.ts b/packages/integrations/image/src/loaders/index.ts index e5010c36d..280fb37c2 100644 --- a/packages/integrations/image/src/loaders/index.ts +++ b/packages/integrations/image/src/loaders/index.ts @@ -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> { |