Incorrect constructor overload: takes only first overload, but not others

🔎 Search Terms

constructor, typescript, Uint32Array, Uint16Array, Uint8Array, Uint32ArrayConstructor, Uint16ArrayConstructor, Uint8ArrayConstructor

🕗 Version & Regression Information

This changed between versions 5.6.3 and 5.7.2

⏯ Playground Link

https://www.typescriptlang.org/play/?target=9&ts=5.7.2#code/FAFwngDgpgBAkgOwCZQB4FEA2UC2UEgDOAwgPYKEgBOArgMYilUwC8MAqgJYEDMATAEEqVAIZgyFavUbMAPh24gAjADYho8eUq0GTGPK4EAHOrETt0pgG5gwAGY0EDTuRggolABR1SOCOXwQABVIKAAuGAQaHAAjKCoAGhg6AAtHAGsAEREQEQAhbgjTMDyaOzt4gEoYAG9gGAaYbBAYADdOKAB3EOgIxBQMbDwCEi0pXSobesbCTs4QVJhvX38EQJ6oarrGneSRQlgAdSgYgHEAGT4AJXwUKm4Acwl3VBAAOnYAOQBlOFPP9CZAD6cE+QTC012u3aXQ2rAUvEEwjEUyhUJiVCgInSqLRdH2RxOF2ut3ij2eaHeX1+-0BQO+AAkAPJXcGQtENGHdULwwzKNTIsC4jkNDFYnG2Dn4g4wY5nS43ZBkhBPcgvKk-P4A4F5ACaQXQEJFjS5cLYfJMguFIrF2OtOxQdhENEwICNxrcKSopE6kS6MHQwiYngABgAiHx+AIEDZhmCcQiRUgtalaumgoJJVO04GMllBGB6bPaoF6g1LAAkNUjq3WoQAvpUQ5UbDt65LGj5JHtMHQXTkoEhSuV4kzygcWmwACytztjHt9zADodlCpUc74B4gFLwozWzEgGhUBB+32m0LeNIILI5fLcJL43v99wrkdUMd2CcPkRPpcv4drhuKrbi2wDtkAA

💻 Code

type IndexElementsConstructor = Uint32ArrayConstructor | Uint16ArrayConstructor | Uint8ArrayConstructor;

function test(componentType: number, chunkDataBin: ArrayBuffer) {
    let viewType: IndexElementsConstructor;

    switch (componentType) {
        case WebGL2RenderingContext.UNSIGNED_INT:
            viewType = Uint32Array;

            break;

        case WebGL2RenderingContext.UNSIGNED_SHORT:
            viewType = Uint16Array;

            break;

        case WebGL2RenderingContext.UNSIGNED_BYTE:
            viewType = Uint8Array;

            break;

        default:
            throw new Error(`"componentType" is not UNSIGNED_INT, UNSIGNED_SHORT or UNSIGNED_BYTE (${componentType})`);
    }

    const calculatedBufferOffset = 4;
    const calculatedBufferLength = 8;

    return new viewType(chunkDataBin, calculatedBufferOffset, calculatedBufferLength);
}

🙁 Actual behavior

🙂 Expected behavior

Additional information about the issue

If change code to simpler variant:

type IndexElementsConstructor = Uint32ArrayConstructor | Uint16ArrayConstructor | Uint8ArrayConstructor;

function test(componentType: number, chunkDataBin: ArrayBuffer) {
    const viewType: IndexElementsConstructor = Uint32Array;

    const calculatedBufferOffset = 4;
    const calculatedBufferLength = 8;

    return new viewType(chunkDataBin, calculatedBufferOffset, calculatedBufferLength);
}

newest TS version recognizes this.

As we can see 3rd overload:

Microsoft VS Code\resources\app\extensions\node_modules\typescript\lib\lib.es5.d.ts:

interface Uint32ArrayConstructor {
    readonly prototype: Uint32Array<ArrayBufferLike>;
    new (length: number): Uint32Array<ArrayBuffer>;
    new (array: ArrayLike<number>): Uint32Array<ArrayBuffer>;
    new <TArrayBuffer extends ArrayBufferLike = ArrayBuffer>(buffer: TArrayBuffer, byteOffset?: number, length?: number): Uint32Array<TArrayBuffer>;
    new (array: ArrayLike<number> | ArrayBuffer): Uint32Array<ArrayBuffer>;

    /**
     * The size in bytes of each element in the array.
     */
    readonly BYTES_PER_ELEMENT: number;

    /**
     * Returns a new array from a set of elements.
     * @param items A set of elements to include in the new array object.
     */
    of(...items: number[]): Uint32Array<ArrayBuffer>;

    /**
     * Creates an array from an array-like or iterable object.
     * @param arrayLike An array-like or iterable object to convert to an array.
     */
    from(arrayLike: ArrayLike<number>): Uint32Array<ArrayBuffer>;

    /**
     * Creates an array from an array-like or iterable object.
     * @param arrayLike An array-like or iterable object to convert to an array.
     * @param mapfn A mapping function to call on every element of the array.
     * @param thisArg Value of 'this' used to invoke the mapfn.
     */
    from<T>(arrayLike: ArrayLike<T>, mapfn: (v: T, k: number) => number, thisArg?: any): Uint32Array<ArrayBuffer>;
}
declare var Uint32Array: Uint32ArrayConstructor;

This isn't a bug in TS, but it's unfortunate fallout of the new feature whereby TypedArrays are generic over ArrayBufferLike as implemented in #59417. You're running afoul of one of the caveats in the the support for calling union types implemented in #29011:

Only one type in the list of union members is allowed to have overloads, and only one type within the list of union members is allowed to have type parameters

So since the new constructors are generic, they have type parameters, and things go sideways. They wanted #59417 not to be a breaking change but I think there are these edge cases where it happens. You should probably change IndexElementsConstructor to

type IndexElementsConstructor = new (buffer: ArrayBuffer, byteOffset?: number, length?: number) =>
    Uint32Array | Uint16Array | Uint8Array;

to make it work again.

Playground link to code

I’m experiencing same problem in ts 5.7 when extending TypedArray class like this:
https://www.typescriptlang.org/play/?target=99#code/KYDwDg9gTgLgBAYwDYEMDOa4A06hsAOwBNMAxJCFGAZgCYBBKKFATzgG8AoORCAtGFACuCGNAAUMAFxwADHAA+cAIyK4tAJQduPOGgDuASxgIAFnElauu3QnTA5UnTZ5ohYYFHHKNzlwCMoYBQAaz8eOzQHZScXXTcPLwJgfThGZhYAISEAMxzPcQ0AGjkSn3DdQOCwuKJgHJQhJGkK13cC5NSAZVMUIKJ01my8guLSlV84nirQvwBfHQWFoA

This issue has been marked as "Design Limitation" and has seen no recent activity. It has been automatically closed for house-keeping purposes.

Joe Calzaretta (@jcalz)

Joe Calzaretta (@jcalz) thanks for explaining. Sadly that during #59417 were not implemented better solutions and when for union types caveats. Because of that all together code in the example above feels like tricky. Or you need to write code that will satisfy TS, code for TS, not for you 😢

Now if we want BYTES_PER_ELEMENT from

type IndexElementsConstructor = Uint32ArrayConstructor | Uint16ArrayConstructor | Uint8ArrayConstructor;

let viewType: IndexElementsConstructor;
...
viewType.BYTES_PER_ELEMENT

things become more complicated.

Ryan Cavanaugh (@RyanCavanaugh)

Marking not interesting issues with "Design Limitation" is very interesting tool for solving problems, is not it, Ryan Cavanaugh (@RyanCavanaugh) ?

Somebody failed once long time ago, someone failed again now and we got mess, but instead of fix "we will close ticket and act like nothing happens"?

Serhii Pustovit (@psnet)

Serhii Pustovit (@psnet) See https://github.com/Microsoft/TypeScript/wiki/FAQ#this-is-closed-but-should-be-open-or-vice-versa

Joe Calzaretta (@jcalz)

When you union constructor types, generic signatures must match exactly. Since each constructor type in the union produces a different return type, they are excluded from the resulting set. In the long term, I can look into adding non-generic overloads for these cases, assuming its feasible to do so without introducing further breaks. In the short term, Joe Calzaretta (@jcalz) suggestion is a good workaround.

Navigation Menu

Repository navigation

Incorrect constructor overload: takes only first overload, but not others #60745

🔎 Search Terms

🕗 Version & Regression Information

⏯ Playground Link

💻 Code

🙁 Actual behavior

🙂 Expected behavior

Additional information about the issue

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Incorrect constructor overload: takes only first overload, but not others #60745

Description

🔎 Search Terms

🕗 Version & Regression Information

⏯ Playground Link

💻 Code

🙁 Actual behavior

🙂 Expected behavior

Additional information about the issue

Activity

psnet commented on Dec 12, 2024

jcalz commented on Dec 12, 2024

rubick24 commented on Dec 13, 2024

typescript-bot commented on Dec 16, 2024

psnet commented on Dec 16, 2024

psnet commented on Dec 16, 2024

psnet commented on Dec 16, 2024

RyanCavanaugh commented on Dec 16, 2024

rbuckton commented on Jan 8, 2025

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions