search

protocolbuffers / protobuf-javascript

BSD 3-Clause "New" or "Revised" License
375 stars 67 forks source link

When is the documentation planned to be published? #220

Closed ericmorand closed 2 months ago

ericmorand commented 2 months ago

Hey team,

We are currently challenging a few protobuf JavaScript and TypeScript libraries and it seems like yours does not have any documentation published.

We are assuming that, considering that the project has started 8 years ago, there is no plan to publish a documentation, but in case we are wrong: when can we expect it to be published?

dibenede commented 2 months ago

There's some documentation in the README, but the bulk of it is here: https://github.com/protocolbuffers/protobuf-javascript/blob/main/docs/index.md .

ericmorand commented 2 months ago

Thank you @dibenede. Can we assume that there is no JavaScript API (to create a namespace, create a message...), or is it not documented yet?

dibenede commented 2 months ago

Sorry, I'm not clear on what you're looking for when you say "to create a namespace, create a message...".

We'll generate a JS API for whatever protobuf files you provide. We do not support reflection/DynamicMessage (something like this in C++).