update README.md

Yo-mah-Ya · Oct 19, 2023 · 9b43cc6 · 9b43cc6
1 parent e174935
commit 9b43cc6
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -3,6 +3,28 @@
 **This library will generate TypeScript types from `.proto` files.
 This does not generate other features like binary serializing/deserializing, toJson/fromJson or other stuff like that.**
 
+## The mapping rules of proto to TypeScript types
+
+| proto    | TypeScript                          |
+| -------- | ----------------------------------- |
+| double   | number                              |
+| float    | number                              |
+| int32    | number                              |
+| uint32   | number                              |
+| sint32   | number                              |
+| fixed32  | number                              |
+| sfixed   | number                              |
+| int64    | bigint                              |
+| uint64   | bigint                              |
+| sint64   | bigint                              |
+| fixed64  | bigint                              |
+| sfixed64 | bigint                              |
+| string   | string                              |
+| bool     | boolean                             |
+| group    | `type_name` of FieldDescriptorProto |
+| enum     | `type_name` of FieldDescriptorProto |
+| message  | `type_name` of FieldDescriptorProto |
+
 ### dependencies
 
 - plugin.proto

diff --git a/src/protobuf/descriptor.ts b/src/protobuf/descriptor.ts
@@ -1875,7 +1875,15 @@ function createBaseFileDescriptorSet(): FileDescriptorSet {
   return { file: [] };
 }
 
-export const FileDescriptorSet = {
+type MessageFileDescriptorSet = {
+  encode(message: FileDescriptorSet, writer: _m0.Writer): _m0.Writer;
+  decode(input: _m0.Reader | Uint8Array, length?: number): FileDescriptorSet;
+  fromJSON(object: any): FileDescriptorSet;
+  toJSON(message: FileDescriptorSet): unknown;
+  create<I extends Exact<DeepPartial<FileDescriptorSet>, I>>(base?: I): FileDescriptorSet;
+  fromPartial<I extends Exact<DeepPartial<FileDescriptorSet>, I>>(object: I): FileDescriptorSet;
+};
+export const FileDescriptorSet: MessageFileDescriptorSet = {
   encode(message: FileDescriptorSet, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
     for (const v of message.file) {
       FileDescriptorProto.encode(v!, writer.uint32(10).fork()).ldelim();
@@ -1948,7 +1956,16 @@ function createBaseFileDescriptorProto(): FileDescriptorProto {
   };
 }
 
-export const FileDescriptorProto = {
+type MessageFileDescriptorProto = {
+  encode(message: FileDescriptorProto, writer: _m0.Writer): _m0.Writer;
+  decode(input: _m0.Reader | Uint8Array, length?: number): FileDescriptorProto;
+  fromJSON(object: any): FileDescriptorProto;
+  toJSON(message: FileDescriptorProto): unknown;
+  create<I extends Exact<DeepPartial<FileDescriptorProto>, I>>(base?: I): FileDescriptorProto;
+  fromPartial<I extends Exact<DeepPartial<FileDescriptorProto>, I>>(object: I): FileDescriptorProto;
+};
+
+export const FileDescriptorProto: MessageFileDescriptorProto = {
   encode(message: FileDescriptorProto, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
     if (message.name && message.name !== "") {
       writer.uint32(10).string(message.name);
@@ -2240,7 +2257,15 @@ function createBaseDescriptorProto(): DescriptorProto {
   };
 }
 
-export const DescriptorProto = {
+type MessageDescriptorProto = {
+  encode(message: DescriptorProto, writer: _m0.Writer): _m0.Writer;
+  decode(input: _m0.Reader | Uint8Array, length?: number): DescriptorProto;
+  fromJSON(object: any): DescriptorProto;
+  toJSON(message: DescriptorProto): unknown;
+  create<I extends Exact<DeepPartial<DescriptorProto>, I>>(base?: I): DescriptorProto;
+  fromPartial<I extends Exact<DeepPartial<DescriptorProto>, I>>(object: I): DescriptorProto;
+};
+export const DescriptorProto: MessageDescriptorProto = {
   encode(message: DescriptorProto, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
     if (message.name !== "") {
       writer.uint32(10).string(message.name);

diff --git a/src/protobuf/plugin.ts b/src/protobuf/plugin.ts
@@ -300,7 +300,16 @@ function createBaseCodeGeneratorRequest(): CodeGeneratorRequest {
   };
 }
 
-export const CodeGeneratorRequest = {
+type MessageCodeGeneratorRequest = {
+  encode(message: CodeGeneratorRequest, writer: _m0.Writer): _m0.Writer;
+  decode(input: _m0.Reader | Uint8Array, length?: number): CodeGeneratorRequest;
+  fromJSON(object: any): CodeGeneratorRequest;
+  toJSON(message: CodeGeneratorRequest): unknown;
+  create<I extends Exact<DeepPartial<CodeGeneratorRequest>, I>>(base?: I): CodeGeneratorRequest;
+  fromPartial<I extends Exact<DeepPartial<CodeGeneratorRequest>, I>>(object: I): CodeGeneratorRequest;
+}
+
+export const CodeGeneratorRequest: MessageCodeGeneratorRequest = {
   encode(message: CodeGeneratorRequest, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
     for (const v of message.file_to_generate) {
       writer.uint32(10).string(v!);