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

protoc-gen-tsd

v0.0.9

Published

Protocol Buffers Compiler(protoc) plugin for TypeScript - Generate definition file(d.ts)

Downloads

52

Readme

protoc-gen-tsd

npm GitHub release (latest by date)

Protoc Plugin for generating TypeScript definition

The library exports the protoc-gen-tsd executable, which generates a TypeScript definition file(.d.ts file).

Quick Start

Installation

npm install protoc-gen-tsd

Usage

export PATH=./node_modules/.bin:$PATH
# single .proto file
protoc --tsd_out=./examples/protos ./examples/protos/echo.proto
# multiple .proto file
protoc --tsd_out=./examples/protos -I=./examples/protos ./examples/protos/*.proto

Packaging Comparison

Some time ago, gRPC released pure JavaScript implementation of client @grpc/grpc-js without a C++ addon.

The @grpc/grpc-js load package definition object(grpc.loadPackageDefinition) requires a @grpc/proto-loader to load the proto file.

@grpc/grpc-js serialization and deserialization protocol buffer messages depend on the @grpc/proto-loader output package definition object.

When we get the protocol buffer message, it has been deserialized and we can get the information directly from the property accessor.

So, to work with TypeScript you only need to declare the type protobuf message.

| .d.ts file | protoc-gen-tsd | ts-protoc-gen | | ---------------------------- | ------------------ | ------------------ | | get/set field | :x: | :heavy_check_mark: | | google-protobuf dependency | :x: | :heavy_check_mark: | | grpc dependency | :x: | :heavy_check_mark: | | @grpc/grpc-js dependency | :heavy_check_mark: | :x: |

Examples

Debug

#!/usr/bin/env node --inspect-brk --require ts-node/register ./src/index.ts
export PATH=./bin:$PATH
protoc --tsd_out=. examples/protos/echo.proto

ejs

<% debugger; %>