microsoft / microsoft/TypeScript

Split TypedArray overload into separate overloads

Offen
#42,354 4 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Awaiting More Feedback Suggestion
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.3k
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
117

Beschreibung

lib Update Request

Configuration Check

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

Missing / Incorrect Definition

All TypedArrays have five overloads, one of which is the following:

TypedArray(buffer: ArrayBuffer, byteOffset?: number, length?: number);

I believe that this should be split into three separate overloads:

new TypedArray(buffer: ArrayBuffer);
new TypedArray(buffer: ArrayBuffer, byteOffset: number);
new TypedArray(buffer: ArrayBuffer, byteOffset: number, length: number);

or

new TypedArray(buffer: ArrayBuffer, byteOffset?: number);
new TypedArray(buffer: ArrayBuffer, byteOffset: number, length: number);

Sample Code

I came across something vaguely like this:

declare function getOffset(): undefined;

const offset = getOffset();

new Uint8Array(new ArrayBuffer(0), offset, 0);

and thought that their code definitely had a bug, but, it turns out that undefined-ish values were allowed for the second parameter, because the type was of number | undefined.

This would break code, but I believe that this will break little to no code in practice.

Documentation Link

N/A: no new additions

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne bei den in der Issue beschriebenen Deklarationen der TypedArray-Konstruktoren und reproduziere das Beispiel, bei dem ein undefinierter offset akzeptiert wird. Vergleiche die vorhandenen overloads mit den vorgeschlagenen separaten arities und überprüfe anschließend, dass gültige Konstruktoraufrufe weiterhin typgeprüft werden, während der Aufruf mit drei Argumenten und einem undefined offset abgelehnt wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
compilers
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.