npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

pbts

v4.0.7

Published

protobuf-to-typescript

Downloads

304

Readme

pbts

NPM version npm download

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);