protocolbuffers / protocolbuffers/protobuf-javascript
Need to better document that toObject() is *not* proto3 JSON
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- JavaScript
- Sterne
- 471
- Forks
- 91
- Ø Merge
- 3 Std. 57 Min.
- Gemergte PRs (30 T.)
- 2
Beschreibung
proto3 JSON mapping specifies special output for some well known types (e.g. Timestamp, Duration). However, the generated _pb.js files for these types treats them as regular protobufs.
Repro code:
var tspb = require('google-protobuf/google/protobuf/timestamp_pb.js');
var t = new tspb.Timestamp();
console.log(t.toObject());
Expected output:
0001-01-01T00:00:00Z
Observed output:
{ seconds: 0, nanos: 0 }
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginnen Sie mit der im Issue verlinkten proto3-JSON-Zuordnung und dem in der Reproduktion gezeigten Verhalten der generierten Datei google-protobuf/google/protobuf/timestamp_pb.js. Stellen Sie in der Dokumentation klar, dass toObject() für well-known types das reguläre protobuf-Objekt und nicht proto3 JSON zurückgibt, und überprüfen Sie die Formulierung anhand des bereitgestellten Timestamp-Beispiels.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100