grpc / grpc/grpc-node

Update grpc documentation & code example for multi-word proto fields

Open
#2,134 1 comment 0 reactions 0 assignees View on GitHub
package: @grpc/grpc-js
Dominant language
TypeScript
Stars
4.8k
Forks
716
Avg merge
2d 3h
Merged PRs (30d)
10

Description

Lack of documentation on naming convention w/ json in grpc-js.

### Is your feature request related to a problem? Please describe.
When using grpc-js w/ proto fields that have multiple words delimited w/ '_', the naming convention in the request/response object is different ( request fields require camel capitalization )

i.e. :

some.proto
```
...
rpc SomeRpc(Request) returns (Response)
message Request{
...
string some_string_field = 1;
}

message Response{
...
string another_string_field = 1;
}
```

some_client_impl.js
```
....
client.someRpc({someStringField:"some string to pass"}, (err, data) => {
...
console.log(data.anotherStringField)
})

```

### Describe the solution you'd like
At minimum the [documentation here](https://grpc.io/docs/languages/node/basics/#client) to detail this requirement out. Ideally the associated code example should be updated to showcase this.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.