Skip to content

L43 update: Add serialize and deserialize methods to proto type objects #503

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
murgatroid99 merged 1 commit into from
Jul 1, 2025
Merged

L43 update: Add serialize and deserialize methods to proto type objects #503

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions L43-node-type-info.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,25 @@ The object structure for representing Protobuf message types will be as follows:

```ts
{
format: "Protocol Buffer 3 DescriptorProto",
type: DescriptorProtoObject,
fileDescriptorProtos: Buffer[]
format: "Protocol Buffer 3 DescriptorProto";
type: DescriptorProtoObject;
fileDescriptorProtos: Buffer[];
serialize: (message: InputType) => Buffer;
deserialize: (serializedMessage: Buffer) => OutputType;
}
```

A `DescriptorProtoObject` is a plain JavaScript object that contains the [canonical JSON Mapping](https://developers.google.com/protocol-buffers/docs/proto3#json) representation of a `DescriptorProto` message defined in the well known proto file `descriptor.proto`. The `fileDescriptorProtos` array contains a list of `.proto` files that is sufficient to fully define this message type, represented as serialized `FileDescriptorProto` messages defined in the same proto file `descriptor.proto`. The primary purpose of this field is to be used in implementing the gRPC reflection API.
A `DescriptorProtoObject` is a plain JavaScript object that contains the [canonical JSON Mapping](https://developers.google.com/protocol-buffers/docs/proto3#json) representation of a `DescriptorProto` message defined in the well known proto file `descriptor.proto`. The `fileDescriptorProtos` array contains a list of `.proto` files that is sufficient to fully define this message type, represented as serialized `FileDescriptorProto` messages defined in the same proto file `descriptor.proto`. The primary purpose of this field is to be used in implementing the gRPC reflection API.The `serialize` and `deserialize` methods convert between `Buffer` objects and the corresponding input and output types that would be accepted and provided by methods generated by this library.

Protobuf enum types will be represented with a nearly identical structure, except with `EnumDescriptorProto` instead of `DescriptorProto`.
Protobuf enum types will be represented with a similar structure:

```ts
{
format: "Protocol Buffer 3 EnumDescriptorProto";
type: DescriptorProtoObject;
fileDescriptorProtos: Buffer[];
}
```

### `@grpc/proto-loader` type output

Expand Down