microsoft / microsoft/TypeScript

RTCStatsReport should inherit or extend from Map

Offen
#58,995 2 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

⚙ Compilation target

ESNEXT

⚙ Library

No idea why this item is mandatory

Missing / Incorrect Definition

RTCStatsReport is defined as follows:

/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCStatsReport) */
interface RTCStatsReport {
    forEach(callbackfn: (value: any, key: string, parent: RTCStatsReport) => void, thisArg?: any): void;
}

As per documentation, RTCStatsReport is a Map-like object so it should include methods such as values(), entries() and members such as size. Note that it must NOT include delete(), clear() or set() since it's read-only (see doc links at the bottom).

However RTCStatsReport TypeScript definition only exposes forEach().

Sample Code
const pc = new RTCPeerConnection();

pc.createDataChannel('foo', { negotiated: true, id: 123, ordered: true });

const stats = await pc.getStats();

console.log('--- num stats:', stats.size);

for (const [id, stat] of stats) {
	console.log('--- stat:', stat);
	console.log('--- stats.get(id):', stats.get(id));
}

Produces:

--- num stats: 2
--- stat: {id: 'D37', timestamp: 1719306842612.802, type: 'data-channel', bytesReceived: 0, bytesSent: 0, …}
--- stats.get(id): {id: 'D37', timestamp: 1719306842612.802, type: 'data-channel', bytesReceived: 0, bytesSent: 0, …}
--- stat: {id: 'P', timestamp: 1719306842612.802, type: 'peer-connection', dataChannelsClosed: 0, dataChannelsOpened: 0}
--- stats.get(id): {id: 'P', timestamp: 1719306842612.802, type: 'peer-connection', dataChannelsClosed: 0, dataChannelsOpened: 0}
Documentation Link

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 der im Issue gezeigten RTCStatsReport-Schnittstelle und vergleiche sie mit der verknüpften MDN-Dokumentation zur map-like API. Bestätige die durch das Beispiel dargestellten schreibgeschützten Member und das Iterationsverhalten, wobei delete(), clear() und set() ausgeschlossen werden; abgeschlossen ist die Aufgabe, wenn die TypeScript-Definition das dokumentierte Verhalten korrekt offenlegt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
web-dev
Issue-Typ
Feature
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
48/100

Neue Issues direkt in Ihr Postfach

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