pbts
TypeScript icon, indicating that this package has built-in type declarations

4.0.1 • Public • Published

pbts

NPM version npm download

It is the cli for pbts. You can convert pb to ts file by command line

CLI Usage

Global Installation

step 1 Install pbts

npm i pbts -g

step 2 Convert your protobuffer to Typescript Definition File

pbts -i input/app/order.proto -o output/order.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);

The result is as follow.

interface MyRequest {
  path: string;
}

Node Library Usage

import { parseProto } from 'pbts';

const source = `
syntax = "proto3";
message MyRequest {
  string path = 1;
}
`;

const ts = parseProto(source);

/pbts/

    Package Sidebar

    Install

    npm i pbts

    Weekly Downloads

    36

    Version

    4.0.1

    License

    MIT

    Unpacked Size

    25.1 kB

    Total Files

    28

    Last publish

    Collaborators

    • brandonxiang