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

ts-twirp

v1.1.3

Published

Generate a TypesScript Twirp server

Downloads

230

Readme

ts-twirp

Build Status

ts-twirp is a TypeScript code generator for Twirp servers and clients.

The client portion of this library is nascent.

Make a Twirp Server

Install ts-twirp.

npm install --save-dev ts-twirp

ts-twirp takes an opinionated approach to file organization. Each protobuf file lives in its own directory and ts-twirp generates sibling files that you can .gitignore.

Place your server's protobuf file in its own directory.

/src
  /twirp
    service.proto

Run ts-twirp on service.proto.

npx ts-twirp src/twirp/service.proto

This generates sibling files in the same directory.

/src
  /twirp
    index.ts # Exports the code you'll use to implement your server
    service.pb.d.ts # Protobuf types generated from your service.proto file
    service.pb.ts # Runtime protobuf serialization/deserialization code
    service.proto # The service protobuf definition
    server.ts # Runtime TypeScript server code

Use src/twirp/index.ts as the entry point to the service types and runtime code.

// ./src/server.ts
import http from 'http';
import { createHaberdasherHandler } from './twirp';

const handler = createHaberdasherHandler({
  async makeHat(size) {
    return ({
      color: 'red',
      name: 'fancy hat',
      size: size.inches
    });
  }
});

http.createServer(handler).listen(8000);

Make a Twirp Client

Running the generator will create both a protobuf and a JSON client.

Using the protobuf client:

import { createHaberdasherProtobufClient } from './twirp';

async function run() {
  const haberdasher = createHaberdasherProtobufClient({
    host: 'localhost',
    port: 8000,
  });

  const hat = await haberdasher.makeHat({
    inches: 42
  });

  console.log(hat);
}

run();

As you might expect using the JSON client is nearly identical.

import { createHaberdasherJSONClient } from './twirp';

async function run() {
  const haberdasher = createHaberdasherJSONClient({
    host: 'localhost',
    port: 8000,
  });

  const hat = await haberdasher.makeHat({
    inches: 42
  });

  console.log(hat);
}

run();