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

pubsub-http-handler

v6.0.0

Published

Handle Google PubSub requests with ease

Downloads

138

Readme

PubSub HTTP Handler

PubSub HTTP Handler

PubSub HTTP Handler is a simple Typescript/Javascript package that solves serving an HTTP endpoint that can consume PubSub messages. To do this task we utilize the Fastify framework or Google Cloud Functions.

This package was built so that when creating microservices that subscribe to a PubSub-topic, we don't have to implement a server or validate the request.

Quickstart

▶ yarn add pubsub-http-handler

Example with Fastify Server

import Fastify from 'fastify';
import { pubSubFastifyPlugin, PubSubHandler } from 'pubsub-http-handler';

interface MyHandler {
  hello: string;
  world: string;
}

const server = async () => {
  const handler: PubSubHandler<MyHandler> = ({ message, data }) => {
    // `message` contains attributes, data (as string), messageId
    // `data` contains a base64 decoded JSON serialized object (type is MyHandler in the example)
    // ...
  };

  const app = Fastify().withTypeProvider<TypeBoxTypeProvider>();

  app.register(pubSubFastifyPlugin, makePubSubConfig({ handler }));

  await app.listen(8000);
};

Example with Google Cloud Functions

import { pubSubCloudFunction, PubSubHandler } from 'pubsub-http-handler';

interface MyHandler {
  hello: string;
  world: string;
}

export const helloWorld = createPubSubCloudFunctions<MyHandler>(
  ({ data, log }) => {
    log.info(`Hello, ${data.name}`);
  },
);

Read more about configuration here or check out the API documentation

Options

  • onError (function, default is undefined). Use to ensure that the function doesn't throw. Warning: Using this option will make the function return 204 regardless.

  • parseJson (boolean, default is true). When set to true, uses JSON.parse to parse the data sent through PubSub.

  • parser (function, optional). This option can be used to parse data coming from PubSub. The function must return data (this data is passed to the handler, as data). You can optionally throw an exception if the data could not be parsed, which in turn can be caught by onError if you'd like.

We export a function called makePubSubConfig to help with type inference. This is basicly a function that lets you return a function while using parser, which is returned in handler. If you know a way for the types to work without using a function like this, we would love a pull request!

Contributing

We love contributions! 🙏 Bug reports and pull requests are welcome on GitHub.