feat(lib): define TypedArray interface #47278
Conversation
|
The TypeScript team hasn't accepted the linked issue #15402. If you can get it accepted, this PR will have a better chance of being reviewed. |
typescript-bot
added
For Backlog Bug
|
|
|
|
||
| interface Float64Array { | ||
| [Symbol.iterator](): IterableIterator<number>; | ||
| interface TypedArray<T> { |
There was a problem hiding this comment.
I think we should have T extends number | bigint here.
| } | ||
|
|
||
| interface Float64ArrayConstructor { | ||
| new (elements: Iterable<number>): Float64Array; | ||
| interface TypedArrayConstructor<T, A extends TypedArray<T>> { |
There was a problem hiding this comment.
same here, I think T should extend number | bigint
| from(arrayLike: Iterable<number>, mapfn?: (v: number, k: number) => number, thisArg?: any): Float32Array; | ||
| } | ||
|
|
||
| interface Float64Array { |
There was a problem hiding this comment.
I think even though we have unified the interfaces, we should still declare them using the new TypedArray, like interface Float64Array extends TypedArray<number> { ... } and interface Float64ArrayConstructor extends TypedArrayConstructor<number, Float64Array> { ... }
| /** | ||
| * Determines whether an array includes a certain element, returning true or false as appropriate. | ||
| * @param searchElement The element to search for. | ||
| * @param fromIndex The position in this array at which to begin searching for searchElement. | ||
| */ | ||
| includes(searchElement: number, fromIndex?: number): boolean; | ||
| includes(searchElement: T, fromIndex?: number): boolean; |
There was a problem hiding this comment.
minor nit: there seems to be an extra leading whitespace here
| @@ -1,35 +1,3 @@ | |||
| interface Int8ArrayConstructor { | |||
There was a problem hiding this comment.
I think we should still also have the old types declared, just now based on TypedArrayConstructor.
|
|
||
| [Symbol.iterator](): IterableIterator<bigint>; | ||
|
|
||
| interface BigUint64Array extends TypedArray<bigint> { |
There was a problem hiding this comment.
I think there are many properties missing from BigUint64Array and BigInt64Array if we declare them that way.
From skimming the properties, I think what we want is for BigInt64Array to extend from TypedArray<bigint> and from ArrayBufferView?
|
|
||
| /** | ||
| * 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): Int8Array; | ||
| from<U>(arrayLike: ArrayLike<U>, mapfn: (v: U, k: number) => bigint, thisArg?: any): BigInt64Array; |
There was a problem hiding this comment.
should that not be something like:
| from<U>(arrayLike: ArrayLike<U>, mapfn: (v: U, k: number) => bigint, thisArg?: any): BigInt64Array; | |
| from<U>(arrayLike: ArrayLike<U>, mapfn: (v: U, k: number) => T, thisArg?: any): A; |
| * search starts at index 0. | ||
| */ | ||
| indexOf(searchElement: number, fromIndex?: number): number; | ||
| interface Uint8Array extends TypedArray<number> {} |
There was a problem hiding this comment.
same as for the bigint declaration, we should probably also extend ArrayBufferLike, I think
|
@mfulton26 |
|
To help with PR housekeeping, I'm going to close this PR since it's pretty old now. |
Each concrete typed array type and constructor share common interfaces.
Library types can be defined extending base interfaces:
Closes #15402
Fixes #45198
Fixes #45199