protocolbuffers / protocolbuffers/protobuf-javascript
Need to better document that toObject() is *not* proto3 JSON
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- JavaScript
- Estrellas
- 471
- Forks
- 91
- Merge medio
- 3 h 57 min
- PR fusionados (30 d)
- 2
Descripción
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 }
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comience con la asignación de JSON de proto3 enlazada en el issue y con el comportamiento de la archivo generado google-protobuf/google/protobuf/timestamp_pb.js mostrado por la reproducción. Aclare en la documentación que toObject() devuelve el objeto protobuf normal para well-known types en lugar de JSON de proto3, y verifique la redacción con el ejemplo de Timestamp proporcionado.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100