pbts
v4.0.7
Published
protobuf-to-typescript
Downloads
304
Readme
pbts
It is the cli for pbts. You can convert protobuf to typescript file by command line
CLI Usage
Global Installation
step 1 Install pbts
npm i pbts -g
step 2 Convert your protobuf to Typescript Definition File
pbts -i input/app/order.proto -o output/order.ts
Description
convert based on local protobuf
Usage
$ pbts [options]
Options
-i, --input input file path
-o, --output output file path
-outputType, --<outputType> output file type, including typescript,definition,jsdoc, default typescript
-mode, --<mode> edge case for int64(long type), including normal,strict, default strict
-v, --version Displays current version
-h, --help Displays this message
Examples
$ pbts -i test.proto -o test.ts
No Installation
Please use npx for short.
npx pbts -i packages/cli/__tests__/__fixtures__/input/app/single.proto -o packages/cli/__tests__/__fixtures__/output/single.ts
Javascript API Usage
Browser Library Usage
import { parseProto } from 'pbts/core';
const source = `
syntax = "proto3";
message MyRequest {
string path = 1;
}
`;
const ts = parseProto(source, {
// Options
outputType,
mode,
});
parameter | type | description ---------|----------|--------- outputType | string | output file type, including typescript,definition,jsdoc, default typescript mode | string | edge case for int64(long type), including normal,strict, default strict
The result is as follow.
interface MyRequest {
path: string;
}
Node Library Usage
More file operation is supported.
import { parseProto } from 'pbts';
const source = `
syntax = "proto3";
message MyRequest {
string path = 1;
}
`;
const ts = parseProto(source);