https://github.com/mean-expert-official/protoc-ts
Protoc compiler plugin for TypeScript service interfaces
https://github.com/mean-expert-official/protoc-ts
grpc plugin protobuf typescript
Last synced: about 1 year ago
JSON representation
Protoc compiler plugin for TypeScript service interfaces
- Host: GitHub
- URL: https://github.com/mean-expert-official/protoc-ts
- Owner: mean-expert-official
- License: mit
- Created: 2017-11-26T00:54:28.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-10-27T17:20:00.000Z (over 7 years ago)
- Last Synced: 2025-03-29T10:51:19.493Z (about 1 year ago)
- Topics: grpc, plugin, protobuf, typescript
- Language: TypeScript
- Size: 37.1 KB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# protoc-ts
> Protoc compiler for TypeScript service interfaces
## Installation
````sh
$ npm install --save @mean-expert/protoc-ts
````
## Usage
* Make sure the protoc compiler is installed. [Compiler Releases](https://github.com/google/protobuf/releases/tag/v3.5.0)
* Invoke `protoc` with:
* `--plugin` - define where the plugin needed for `ts_out` can be found
* `--ts_out` - the params and directory to output to
* `generated` - output directory name
* `-I` - Protos root directory
```sh
protoc \
--plugin=protoc-ts=./node_modules/.bin/protoc-ts \
--ts_out=service=true:generated \
-I ./proto \
proto/*.proto
```