createImageBitmap() imageOrientation option type incorrect in 5.0.0-beta

[frank-weindel]

lib Update Request

Configuration Check

My compilation target is ES2022 and my lib is the default.

Missing / Incorrect Definition

In 5.0.0-beta the DOM provided createImageBitmap (MDN linked) function is not allowing the string "none" to be set on the imageOrientation option property.

It should be allowing the strings "flipY" | "none" according to MDN (and does work in previous TS versions) but in 5.0.0-beta the only strings allowed are: "flipY" | "from-image".

"from-image" seems to be coming from a related but separate CSS property called image-orientation.

node_modules/typescript/lib/lib.dom.d.ts:

// ...
interface ImageBitmapOptions {
    colorSpaceConversion?: ColorSpaceConversion;
    imageOrientation?: ImageOrientation;
    premultiplyAlpha?: PremultiplyAlpha;
    resizeHeight?: number;
    resizeQuality?: ResizeQuality;
    resizeWidth?: number;
}
// ...
declare function createImageBitmap(image: ImageBitmapSource, options?: ImageBitmapOptions): Promise<ImageBitmap>;
declare function createImageBitmap(image: ImageBitmapSource, sx: number, sy: number, sw: number, sh: number, options?: ImageBitmapOptions): Promise<ImageBitmap>;
// ...
type ImageOrientation = "flipY" | "from-image";
// ...

Sample Code

Sample:

createImageBitmap({} as ImageBitmap, {
    imageOrientation: 'none'
 // ^^^^^^^^^^^^^^^^ Type '"none"' is not assignable to type 'ImageOrientation | undefined'.(2322)
});

Playground Link

Documentation Link

https://developer.mozilla.org/en-US/docs/Web/API/createImageBitmap

[frank-weindel]

I've copied this as:

• createImageBitmap() imageOrientation option type incorrect in 5.0.0-beta TypeScript-DOM-lib-generator#1507

[Josh-Cena]

For posterity, there is a change to the createImageBitmap API that MDN is not catching up with (and even seems to be unfinished within the standard group). See mdn/content#23564, mdn/content#24857. microsoft/TypeScript-DOM-lib-generator#1507 also has some more information.

[jakebailey]

This was fixed in #53652.