protocolbuffers / protocolbuffers/protobuf-javascript
Need to better document that toObject() is *not* proto3 JSON
Nessuno ha ancora preso questa issue.
- Lingua principale
- JavaScript
- Stelle
- 471
- Fork
- 91
- Merge medio
- 3h 57m
- PR unite (30g)
- 2
Descrizione
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 }
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia con la mappatura JSON proto3 collegata nell’issue e con il comportamento del file generato google-protobuf/google/protobuf/timestamp_pb.js mostrato dalla riproduzione. Chiarisci nella documentazione che toObject() restituisce il normale oggetto protobuf per i well-known types anziché JSON proto3 e verifica la formulazione rispetto all’esempio Timestamp fornito.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100