@flytio/protos

Flyt service protos

Stats

StarsIssuesVersionUpdatedCreatedSize
@flytio/protos
2.6.02 days ago3 years agoMinified + gzip package size for @flytio/protos in KB

Readme

npm version

What are protocol buffers?

See https://developers.google.com/protocol-buffers/docs/overview

Installation

First you need to install google's proto buffers on your system and typescript

> brew install protobuf
> yarn install

Services

Documentation for each service

How to update the proto definitions for TypeScript

Since there is no protobuf compiler support for TypeScript, we are maintaining the compiled version manually. We are aware that this is a pain, and we'll look to a way of add support to TypeScript, either as our own open source project, or improving the existing plugin (which, at the moment, is not working correctly).

So, when you update proto definitions, you have to:

  • Update the TS definitions in the index.ts file.
  • Update CHANGELOG.md
  • Update the version in package.json.
  • Open your PR for review.

After your PR is approved and merged to master:

Generating protobuf Go files

If you want to generate protos in go you have to:

  1. Install protobuf using brew: brew install protobuf

  2. Install golang support for protobufs from here: https://github.com/golang/protobuf

  3. Clone https://github.com/flypay/protos-go into the parent directory of this repo

  4. Run this command

> make golang

Troubleshooting

If make golang complains that it can not find executable protoc-gen-go execute the following command from the terminal:

go get -u github.com/golang/protobuf/{proto,protoc-gen-go}

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.