protoc-gen-twirp_typescript

README

Active Maintainers Requested See Issue #56

Twirp Typescript Plugin

A protoc plugin for generating a twirp client suitable for browser and node.js projects.

This plugin supports two different outputs when generating code:

1. A minimal standalone client that supports JSON transport only.
2. Protobuf.js adapter for RPC calls to a twirp server.

Setup

The protobuf v3 compiler is required. You can get the latest precompiled binary for your system here:

https://github.com/google/protobuf/releases

Twirp Go Server (optional)

While not required for generating the client code, it is required to run the server component of the example.

go get github.com/twitchtv/twirp/protoc-gen-twirp
go get -u github.com/golang/protobuf/protoc-gen-go

Usage

All generated files will be placed relative to the specified output directory for the plugin.
This is different behavior than the twirp Go plugin, which places the files relative to the input proto files.

This decision is intentional, since only client code destination is likely somewhere different than the server code.

Generating Code for Twirp v6

By default code is generated that supports the twirp v5 spec. If you want to use the the v6 prerelease specify the version using protoc params.

protoc --twirp_typescript_out=version=v6:<path-to-project> <path-to-proto-file>

The relevant change here is the routing path, which now starts with the proto package instead of "twirp/".

• Minimal JSON Client Usage
• Protobuf.js Client Usage