proto_ts_schema
v1.0.1
Published
proto to ts schema compiler/transpiler.
Downloads
1
Maintainers
Readme
proto_to_ts_schema
proto to ts schema compiler/transpiler.
Usage
Proto to TS Schema
config
: Path to the config file which must be in js/ts format. (default: CWD/p2t.js) usage: --config [-c]
help
: To show help docs. usage: --help [-h]
out
: Path to output folder. (default: CWD) usage: --out [-o ]
proto_files
: List of proto files to compile to TS. (default: All proto files inside of 'proto_path' or CWD) usage: --proto_files <filename.proto> <filename2.proto> [-f <files.prot>]
proto_path
: Path to Proto folder, (default: CWD) usage: --proto_path [-p ]
CLI Usage with p2ti
install package globally: npm i -g proto_ts_schema
.
- To show help docs:
p2ti -h
Config Example
module.exports = {
rpcFuncReturn: undefined, // Function (type:string) =>string
imports: [], // Additional imports to include in TS file. Options: Array<string> | undefined
};
Known Caveats
(There are many caveats in this compiler still to be found but here are some known caveats)
- Ordering of the
message
in proto matters. You need to declare proto message first then only you can use it else it will result in error.
Features
- Support for Relative Imports
- Support for config file
- Built in CLI