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

@google-cloud/pubsub

v4.3.3

Published

Cloud Pub/Sub Client Library for Node.js

Downloads

5,282,794

Readme

Google Cloud Pub/Sub: Node.js Client

release level npm version

Cloud Pub/Sub is a fully-managed real-time messaging service that allows you to send and receive messages between independent applications.

This document contains links to an API reference, samples, and other resources useful to developing Node.js applications. For additional help developing Pub/Sub applications, in Node.js and other languages, see our Pub/Sub quickstart, publisher, and subscriber guides.

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Google Cloud Pub/Sub API.
  4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/pubsub

Using the client library

// Imports the Google Cloud client library
const {PubSub} = require('@google-cloud/pubsub');

async function quickstart(
  projectId = 'your-project-id', // Your Google Cloud Platform project ID
  topicNameOrId = 'my-topic', // Name for the new topic to create
  subscriptionName = 'my-sub' // Name for the new subscription to create
) {
  // Instantiates a client
  const pubsub = new PubSub({projectId});

  // Creates a new topic
  const [topic] = await pubsub.createTopic(topicNameOrId);
  console.log(`Topic ${topic.name} created.`);

  // Creates a subscription on that new topic
  const [subscription] = await topic.createSubscription(subscriptionName);

  // Receive callbacks for new messages on the subscription
  subscription.on('message', message => {
    console.log('Received message:', message.data.toString());
    process.exit(0);
  });

  // Receive callbacks for errors on the subscription
  subscription.on('error', error => {
    console.error('Received error:', error);
    process.exit(1);
  });

  // Send a message to the topic
  topic.publishMessage({data: Buffer.from('Test message!')});
}

Running gRPC C++ bindings

For some workflows and environments it might make sense to use the C++ gRPC implementation, instead of the default one (see: #770):

To configure @google-cloud/pubsub to use an alternative grpc transport:

  1. npm install grpc, adding grpc as a dependency.

  2. instantiate @google-cloud/pubsub with grpc:

    const {PubSub} = require('@google-cloud/pubsub');
    const grpc = require('grpc');
    const pubsub = new PubSub({grpc});

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

| Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | | Commit an Avro-Based Schema | source code | Open in Cloud Shell | | Commit an Proto-Based Schema | source code | Open in Cloud Shell | | Create an Avro based Schema | source code | Open in Cloud Shell | | Create BigQuery Subscription | source code | Open in Cloud Shell | | Create a Proto based Schema | source code | Open in Cloud Shell | | Create Push Subscription | source code | Open in Cloud Shell | | Create Push Subscription With No Wrapper | source code | Open in Cloud Shell | | Create Subscription | source code | Open in Cloud Shell | | Create Subscription With Dead Letter Policy | source code | Open in Cloud Shell | | Create an exactly-once delivery subscription | source code | Open in Cloud Shell | | Create Subscription With Filtering | source code | Open in Cloud Shell | | Create Subscription with ordering enabled | source code | Open in Cloud Shell | | Create Subscription With Retry Policy | source code | Open in Cloud Shell | | Create Topic | source code | Open in Cloud Shell | | Create Topic With Schema | source code | Open in Cloud Shell | | Create Topic With Schema Revisions | source code | Open in Cloud Shell | | Delete a previously created schema | source code | Open in Cloud Shell | | Delete a Schema Revision | source code | Open in Cloud Shell | | Delete Subscription | source code | Open in Cloud Shell | | Delete Topic | source code | Open in Cloud Shell | | Detach Subscription | source code | Open in Cloud Shell | | Get a previously created schema | source code | Open in Cloud Shell | | Get a previously created schema revision | source code | Open in Cloud Shell | | Get Subscription | source code | Open in Cloud Shell | | Get Subscription Policy | source code | Open in Cloud Shell | | Get Topic Policy | source code | Open in Cloud Shell | | List All Topics | source code | Open in Cloud Shell | | List Revisions on a Schema | source code | Open in Cloud Shell | | List schemas on a project | source code | Open in Cloud Shell | | List Subscriptions | source code | Open in Cloud Shell | | List Subscriptions On a Topic | source code | Open in Cloud Shell | | Listen For Avro Records | source code | Open in Cloud Shell | | Listen For Avro Records With Revisions | source code | Open in Cloud Shell | | Listen For Errors | source code | Open in Cloud Shell | | Listen For Messages | source code | Open in Cloud Shell | | Listen with exactly-once delivery | source code | Open in Cloud Shell | | Listen For Protobuf Messages | source code | Open in Cloud Shell | | Listen For Messages With Custom Attributes | source code | Open in Cloud Shell | | Modify Push Configuration | source code | Open in Cloud Shell | | OpenTelemetry Tracing | source code | Open in Cloud Shell | | Publish Avro Records to a Topic | source code | Open in Cloud Shell | | Publish Batched Messages | source code | Open in Cloud Shell | | Publish Message | source code | Open in Cloud Shell | | Publish Message With Custom Attributes | source code | Open in Cloud Shell | | Publish Ordered Message | source code | Open in Cloud Shell | | Publish Protobuf Messages to a Topic | source code | Open in Cloud Shell | | Publish with flow control | source code | Open in Cloud Shell | | Publish With Retry Settings | source code | Open in Cloud Shell | | Quickstart | source code | Open in Cloud Shell | | Remove Dead Letter Policy | source code | Open in Cloud Shell | | Resume Publish | source code | Open in Cloud Shell | | Rollback a Schema | source code | Open in Cloud Shell | | Set Subscription IAM Policy | source code | Open in Cloud Shell | | Set Topic IAM Policy | source code | Open in Cloud Shell | | Subscribe With Flow Control Settings | source code | Open in Cloud Shell | | Synchronous Pull | source code | Open in Cloud Shell | | Synchronous Pull with delivery attempt. | source code | Open in Cloud Shell | | Synchronous Pull With Lease Management | source code | Open in Cloud Shell | | Test Subscription Permissions | source code | Open in Cloud Shell | | Test Topic Permissions | source code | Open in Cloud Shell | | Update Dead Letter Policy | source code | Open in Cloud Shell | | Update Topic Schema | source code | Open in Cloud Shell | | Validate a schema definition | source code | Open in Cloud Shell |

The Google Cloud Pub/Sub Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/pubsub@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0

See LICENSE