microsoft / microsoft/TypeScript

The entries collection in observers should be non-empty

Offen
#61,691 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Experience Enhancement Help Wanted Suggestion
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.3k
Ø Merge
2 T. 4 Std.
Gemergte PRs (30 T.)
132

Beschreibung

### ⚙ Compilation target

ES2017

### ⚙ Library

TypeScript

### Missing / Incorrect Definition

The type in question is `ResizeObserverCallback`, and similar observer callbacks, like the ones in `MutationObserver` and `IntersectionObserver`. These currently accept entries in the `T[]` format, but it should really be `[T, ...T[]]`. This is because the observer callback is only ever invoked when there is at least one entry.

(I've also noticed the same issue with the `ResizeObserverEntry`'s `contentBoxSize` property.)

### Sample Code

```TypeScript
const ro = new ResizeObserver(entries => {
const entry = entries[0] // <-- This should never be undefined
const size = entry.contentBoxSize[0] // <-- Nor this, btw
const dim = size.blockSize
console.log(dim / 2)
})
```

### Documentation Link

While there is no direct verbiage that suggests the entry collection is never empty, it stems from the description of the algorithms. For example in case of the `ResizeObserver`:

https://drafts.csswg.org/resize-observer/#broadcast-active-resize-observations

The observer callback is never invoked if there are no observations. Otherwise, entries are created for each observation. This pretty much guarantees the entries collection is non-empty.

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 mit dem Typ ResizeObserverCallback und vergleiche die zugehörigen Callbacks von MutationObserver und IntersectionObserver. Untersuche anschließend ResizeObserverEntry.contentBoxSize. Verwende den broadcast-active-resize-observations-Algorithmus der Resize Observer specification als Referenz; die Arbeit ist abgeschlossen, wenn diese Entry-Sammlungen als nicht leere Tupel typisiert sind, für die die Spezifikation mindestens ein Element garantiert.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
frontend
Issue-Typ
Bug
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

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