Protobuf.jsを使って.protoファイルからTypeScriptの型定義ファイルを生成する

概要

Protobuf.jsを使って.protoファイルからNode.jsのgRPC clientコードを生成するでは、javascriptのmessage定義とclient実装を自動生成しましたが、今回は、これらのjavascriptに対応する型定義ファイル(.d.ts)を自動生成してみたいと思います。

前提

Protobuf.jsを使って.protoファイルからNode.jsのgRPC clientコードを生成する)の 生成するまでを手元で動作させていることが前提です。

型定義ファイルを生成する

次のコマンドを実行して型定義ファイルを生成する。

pbts \
--out ./hero_pb.d.ts \
./hero_pb.js

Protobuf.jsでは、.protoファイルから直接 .d.ts を生成するのではなく、 pbjsで生成したjsファイルをインプットとして .d.ts を生成するようになっています。

生成されるファイルの確認

• hero_pb.d.ts
  • hero_pb.jsに対する型定義ファイル

参考

• https://github.com/dcodeIO/ProtoBuf.js/