2.18.1 • Published 23 hours ago

@google-cloud/pubsub v2.18.1

Weekly downloads
646,791
License
Apache-2.0
Repository
github
Last release
23 hours ago

Google Cloud Pub/Sub: Node.js Client

release level npm version codecov

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
  topicName = '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(topicName);
  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.publish(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.

SampleSource CodeTry it
Create an Avro based Schemasource codeOpen in Cloud Shell
Create a Proto based Schemasource codeOpen in Cloud Shell
Create Push Subscriptionsource codeOpen in Cloud Shell
Create Subscriptionsource codeOpen in Cloud Shell
Create Subscription With Dead Letter Policysource codeOpen in Cloud Shell
Create Subscription with ordering enabledsource codeOpen in Cloud Shell
Create Topicsource codeOpen in Cloud Shell
Create Topic With Schemasource codeOpen in Cloud Shell
Delete a previously created schemasource codeOpen in Cloud Shell
Delete Subscriptionsource codeOpen in Cloud Shell
Delete Topicsource codeOpen in Cloud Shell
Detach Subscriptionsource codeOpen in Cloud Shell
Get a previously created schemasource codeOpen in Cloud Shell
Get Subscriptionsource codeOpen in Cloud Shell
Get Subscription Policysource codeOpen in Cloud Shell
Get Topic Policysource codeOpen in Cloud Shell
List All Topicssource codeOpen in Cloud Shell
List schemas on a projectsource codeOpen in Cloud Shell
List Subscriptionssource codeOpen in Cloud Shell
List Subscriptions On a Topicsource codeOpen in Cloud Shell
Listen For Avro Recordssource codeOpen in Cloud Shell
Listen For Errorssource codeOpen in Cloud Shell
Listen For Messagessource codeOpen in Cloud Shell
Listen For Protobuf Messagessource codeOpen in Cloud Shell
Listen For Messages With Custom Attributessource codeOpen in Cloud Shell
Modify Push Configurationsource codeOpen in Cloud Shell
OpenTelemetry Tracingsource codeOpen in Cloud Shell
Publish Avro Records to a Topicsource codeOpen in Cloud Shell
Publish Batched Messagessource codeOpen in Cloud Shell
Publish Messagesource codeOpen in Cloud Shell
Publish Message With Custom Attributessource codeOpen in Cloud Shell
Publish Ordered Messagesource codeOpen in Cloud Shell
Publish Protobuf Messages to a Topicsource codeOpen in Cloud Shell
Publish with flow controlsource codeOpen in Cloud Shell
Publish With Retry Settingssource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell
Remove Dead Letter Policysource codeOpen in Cloud Shell
Resume Publishsource codeOpen in Cloud Shell
Set Subscription IAM Policysource codeOpen in Cloud Shell
Set Topic IAM Policysource codeOpen in Cloud Shell
Subscribe With Flow Control Settingssource codeOpen in Cloud Shell
Synchronous Pullsource codeOpen in Cloud Shell
Synchronous Pull with delivery attempt.source codeOpen in Cloud Shell
Synchronous Pull With Lease Managementsource codeOpen in Cloud Shell
Test Subscription Permissionssource codeOpen in Cloud Shell
Test Topic Permissionssource codeOpen in Cloud Shell
Update Dead Letter Policysource codeOpen 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.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed via npm dist-tags. The dist-tags follow the naming convention legacy-(version).

Legacy Node.js versions are supported as a best effort:

  • Legacy versions will not be tested in continuous integration.
  • Some security patches may not be able to be backported.
  • Dependencies will not be kept up-to-date, and features will not be backported.

Legacy tags available

  • legacy-8: install client libraries from this dist-tag for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be General Availability (GA). This means it is 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 GA 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

roit-queues@bonobolabs/firebase-tools-deploy-parallelismwp-connection-utilselaah-api@clearvue/pubsubpubsub-testsitka-pubsub-node@9e15/com-uniheap-pubsub-schema@autofleet/node-commonconnect-activity-logmicroservice-emailcryptotalk-pubsub-bridgemc-change-history-sync-actions-gcfgcloud-pubsubsmoothy-core-testn8n-google-pubsub-nodescompositor-engineaol-utils-testmq-wrapper@ourtradehub/dblibrarycentauro-node-component@csdevcloud/cs-corenest-eventoservice-mailing@openbanking/ms-data@openbanking/ms-oauth@openbanking/ms-oauth-consentgalileo-webhookssettlements-server@poomosjs/pub-sub-emulator@wemystic/utilsprodap-chatbot-metricas@shio-bot/foundation@shio-bot/fulfillmentpromoter@samwen/gcp-utils@sandboxvr/graphql-google-pubsubpublisher-libpub-sub-seederpubsubseedpubsub-transporterbeast-apipubsub-subscriberpubsub-plus-emulatorpubsub-pull-pushpubsub-nodeberlioz-gcpberlioz-gcp-sdk@sentrei/functionsbetajs-google-datapubsub-gcppubsub-emulatorpubsub-bridgepulltopparse-server-gcloud-pubsubopentelemetry-instrumentation-pubsub@pyitphyoaung/pubsubwordassoserverword-serverwrapper-andela-pubsubwuhalog@recursyve/email-client@recursyve/nestjs-pidgey@rotorsoft/eventually-gcppipedream@project-furnace/gc-pub-sub-connectoratomist-skillpd.gcpant-nodejs-kitoutrigger-utilsparadox-google-pubsub@roit/roit-queuespliancy-cli@wondersys/zanetto-lib@tutorbot/microservice@types/google-cloud__pubsub@vultuk/microservice-pubsub@walmartlabs/cookie-cutter-gcp@ucd-lib/job-autoscaler-commons@upvest/api-tests@valentine-stone/googleapi-utils@tricky-max/nestjs-pubsub-health-check@cubejs-backend/serverless-google@toolsense/pubsub@wave-server/common@wave-server/wave_pubsub@condomi/helpers@condomi/bot-cli@hatsa/pubsub@wpp-dti-aca/core@slimslenderslacks/api-cljsblondie-platform-functions@sobernation/queuegoogle-cloud-pub-subgraphql-gcp-pubsubsecurity_goocgoogle-pubsub-abstractiongoogle-pubsub-cligoogle-pubsub-wrapperrx-cloud-pubsub
2.18.1

23 hours ago

2.18.0

5 days ago

2.17.0

1 month ago

2.16.6

1 month ago

2.16.5

1 month ago

2.16.4

1 month ago

2.16.3

2 months ago

2.16.2

2 months ago

2.16.1

2 months ago

2.16.0

3 months ago

2.15.1

3 months ago

2.14.0

3 months ago

2.13.0

4 months ago

2.11.1-pre

5 months ago

2.11.1-pre.1

5 months ago

2.12.0

5 months ago

2.11.0

6 months ago

2.10.0

7 months ago

2.9.0

8 months ago

2.8.0

9 months ago

2.7.0

10 months ago

2.6.0

11 months ago

2.5.0

1 year ago

2.4.0

1 year ago

2.3.0

1 year ago

2.2.0

1 year ago

2.1.0

1 year ago

2.0.0

1 year ago

1.7.3

1 year ago

2.0.0-beta.0

1 year ago

1.7.2

1 year ago

1.7.1

1 year ago

1.7.0

1 year ago

1.6.0

2 years ago

1.5.0

2 years ago

1.4.1

2 years ago

1.4.0

2 years ago

1.3.0

2 years ago

1.2.0

2 years ago

1.1.6

2 years ago

1.1.6-beta.0

2 years ago

1.1.5

2 years ago

1.1.4

2 years ago

1.1.3

2 years ago

1.1.2

2 years ago

1.1.1

2 years ago

1.1.0

2 years ago

1.0.0

2 years ago

0.32.1

2 years ago

0.32.0

2 years ago

0.31.1

2 years ago

0.31.0

2 years ago

0.30.3

2 years ago

0.30.2

2 years ago

0.30.1

2 years ago

0.30.0

2 years ago

0.29.1

2 years ago

0.29.0

2 years ago

0.28.1

3 years ago

0.28.0

3 years ago

0.27.1

3 years ago

0.27.0

3 years ago

0.26.0

3 years ago

0.25.0

3 years ago

0.24.1

3 years ago

0.24.0

3 years ago

0.23.0

3 years ago

0.22.2

3 years ago

0.22.1

3 years ago

0.22.0

3 years ago

0.21.1

3 years ago

0.21.0

3 years ago

0.20.1

3 years ago

0.20.0

3 years ago

0.19.1

3 years ago

0.19.0

3 years ago

0.18.0

4 years ago

0.17.0

4 years ago

0.16.5

4 years ago

0.16.4

4 years ago

0.16.3

4 years ago

0.16.2

4 years ago

0.16.1

4 years ago

0.16.0

4 years ago

0.15.0

4 years ago

0.14.8

4 years ago

0.14.7

4 years ago

0.14.6

4 years ago

0.14.5

4 years ago

0.14.4

4 years ago

0.14.3

4 years ago

0.14.2

4 years ago

0.14.1

4 years ago

0.14.0

4 years ago

0.13.2

4 years ago

0.13.1

4 years ago

0.13.0

4 years ago

0.12.0

4 years ago

0.11.0

4 years ago

0.10.0

4 years ago

0.9.0

4 years ago

0.8.3

5 years ago

0.8.2

5 years ago

0.8.1

5 years ago

0.9.0-0

5 years ago

0.8.0

5 years ago

0.7.1

5 years ago

0.6.2

5 years ago

0.6.1

5 years ago

0.7.0

5 years ago

0.6.0

5 years ago

0.5.0

5 years ago

0.4.0

5 years ago

0.3.0

5 years ago

0.2.0

5 years ago

0.1.1

5 years ago

0.1.0

5 years ago