pojntfx/polyglot-ts

TypeScript version of the Polyglot data encoding library.

polyglot-ts

TypeScript library and protoc plugin used for encoding and decoding data types from a portable byte buffer, used in fRPC

Installation

protoc Plugin

Static binaries are available on GitHub releases.

On Linux, you can install them like so:

$ curl -L -o /tmp/protoc-gen-polyglot-ts "https://github.com/loopholelabs/polyglot-ts/releases/latest/download/protoc-gen-polyglot-ts.linux-$(uname -m)"
$ sudo install /tmp/protoc-gen-polyglot-ts /usr/local/bin

On macOS, you can use the following:

$ curl -L -o /tmp/protoc-gen-polyglot-ts "https://github.com/loopholelabs/polyglot-ts/releases/latest/download/protoc-gen-polyglot-ts.darwin-$(uname -m)"
$ sudo install /tmp/protoc-gen-polyglot-ts /usr/local/bin

On Windows, the following should work (using PowerShell as administrator):

PS> Invoke-WebRequest https://github.com/loopholelabs/polyglot-ts/releases/latest/download/protoc-gen-polyglot-ts.windows-x86_64.exe -OutFile \Windows\System32\protoc-gen-polyglot-ts.exe

Use the plugin like so:

$ protoc --polyglot-ts_out=. definition.proto

You can also find binaries for more operating systems and architectures on GitHub releases.

Library

Using npm:

$ npm install --save @loopholelabs/polyglot-ts

Using Yarn:

$ yarn add @loopholelabs/polyglot-ts

See the docs for usage information.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/loopholelabs/polyglot-ts. For more contribution information check out the contribution guide.

License

The Polyglot project is available as open source under the terms of the Apache License, Version 2.0.

Code of Conduct

Everyone interacting in the Polyglot project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the CNCF Code of Conduct.

Project Managed By: