Help us understand the problem. What is going on with this article?

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

More than 1 year has passed since last update.

概要

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に対する型定義ファイル

参考

daikiojm
Blog: http://daikiojm.hatenablog.com Scrapbox: https://scrapbox.io/daikiojm
Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away