proto-gen-dts
Convert
protofile totypescripttype definition file;
All that is needed at present has been completed, enjoy 😊
Install
# global
npm i proto-gen-dts -gFeatures
- ✔︎ Support
proto2proto3 - ✔︎ Support generate
protodependent modules - ✔︎ Support generate
dtsentry file - ✔︎ Support all
protomessage type - ✔︎ Support generate
servicetointerfaces - ✔︎ Keep generating comments and order
Special comment support
-
@v: requiredinterface field well required
Usage
// use in nodejs
const protoGenDts = require('proto-gen-dts');
const dtsFiles = protoGenDts.default({
files: [
{
file: 'hello.proto',
output: 'typings/hello.d.ts',
generateDependentModules: true
}
],
referenceEntryFile: 'typings/index.d.ts'
})# use in shell
# single file
proto-gen-dts hello.proto -o typings/hello.d.ts -e typings/index.d.ts
# dir
proto-gen-dts -d protos/ -o typings/
# use npx
npx proto-gen-dts -d protos/ -o typings/
# --keepcase, Converted to camel case by default
proto-gen-dts -d protos/ -o typings/ --keepcaseExample
Source hello.proto
syntax = "proto3";
import "core.proto";
import "google/protobuf/any.proto";
import "google/protobuf/descriptor.proto";
package hello;
service Hello {
/**
* hello
*/
rpc SayName (SayNameReq) returns (SayNameRsp) {};
// remark
// get user list
rpc GetUserList (GetUserListReq) returns (GetUserListRsp) {};
rpc GetSayNameUser (SayNameReq.User) returns (SayNameReq.User) {}
}
message Core {
string first_name = 1;
}
enum Direct {
Nil = 0;
Up = 1;
Down = 2;
}
// 测试评论
message SayNameReq {
// 用户模型
message User {
// 用户名
string name = 1;
string avatar = 2;
enum Role {
RoleNil = 0;
// admin
RoleAdmin = 1;
}
}
string full_name = 1;
Core core = 2;
repeated User user = 3;
Direct direct = 4;
}
message SayNameRsp {
message Stock {
// Stock-specific data
}
message Currency {
// Currency-specific data
}
string realName = 1;
map<uint32, SayNameReq.User> user_map = 2;
map<uint32, SayNameReq.User.Role> role_map = 3;
map<uint32, uint64> link_map = 4;
repeated google.protobuf.Any details = 5;
oneof instrument {
Stock stock = 6;
Currency currency = 7;
}
google.protobuf.FieldDescriptorProto field_descriptor = 8;
}
message GetUserListReq {
core.XXX xxx = 1;
core.ListOptions.Option option = 2;
}
message GetUserListRsp {}Output typings/hello.d.ts
/** code generate by proto-gen-dts don't edit */
declare namespace hello {
export interface HelloService {
// hello
SayName<R extends SayNameReq, O>(r: R, o?: O): Promise<SayNameRsp>;
// remark
// get user list
GetUserList<R extends GetUserListReq, O>(
r: R,
o?: O
): Promise<GetUserListRsp>;
GetSayNameUser<R extends SayNameReq_User, O>(
r: R,
o?: O
): Promise<SayNameReq_User>;
}
export interface Core {
firstName?: string;
}
export const enum Direct {
Nil = 0,
Up = 1,
Down = 2,
}
// 测试评论
export interface SayNameReq {
fullName?: string;
core?: Core;
user?: SayNameReq_User[];
direct?: Direct;
}
// 用户模型
export interface SayNameReq_User {
// 用户名
name?: string;
avatar?: string;
}
export const enum SayNameReq_User_Role {
RoleNil = 0,
// admin
RoleAdmin = 1,
}
export interface SayNameRsp {
realName?: string;
userMap?: Record<number, SayNameReq_User>;
roleMap?: Record<number, SayNameReq_User_Role>;
linkMap?: Record<number, string>;
details?: google.protobuf.Any[];
stock?: SayNameRsp_Stock;
currency?: SayNameRsp_Currency;
fieldDescriptor?: google.protobuf.FieldDescriptorProto;
}
export interface SayNameRsp_Stock {}
export interface SayNameRsp_Currency {}
export interface GetUserListReq {
xxx?: core.XXX;
option?: core.ListOptions_Option;
}
export interface GetUserListRsp {}
}referenceEntryFile output typings/index.d.ts
/** code generate by proto-gen-dts don't edit */
/// <reference path="hello.d.ts" />
/// <reference path="core.d.ts" />
/// <reference path="google/protobuf/any.d.ts" />
/// <reference path="google/protobuf/descriptor.d.ts" />generateDependentModules will generate dependent modules
typings/core.d.tstypings/google/protobuf/any.d.tstypings/google/protobuf/descriptor.d.ts