Node.js client for Google Cloud Pub/Sub: Ingest event streams from anywhere, at any scale, for simple, reliable, real-time stream analytics.
Installations
npm install @google-cloud/pubsubDeveloper
Developer Guide
Module System
CommonJS
Min. Node Version
>=14.0.0
Typescript Support
Yes
Node Version
14.21.3
NPM Version
6.14.18
Statistics
525 Stars
1,187 Commits
227 Forks
62 Watching
70 Branches
191 Contributors
Updated on 27 Nov 2024
Bundle Size
1.59 MB
Minified
283.69 kB
Minified + Gzipped
Languages
TypeScript (99.35%)
JavaScript (0.55%)
Python (0.1%)
Total Downloads
Cumulative downloads
Total Downloads
233,555,984
Last day
1.1%
271,063
Compared to previous day
Last week
2.9%
1,417,999
Compared to previous week
Last month
10.2%
5,892,481
Compared to previous month
Last year
14.7%
63,143,225
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
14
Dev Dependencies
40
Google Cloud Pub/Sub: Node.js Client
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.
- Google Cloud Pub/Sub Node.js Client API Reference
- Google Cloud Pub/Sub Documentation
- github.com/googleapis/nodejs-pubsub
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
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the Google Cloud Pub/Sub API.
- Set up authentication so you can access the API from your local workstation.
Installing the client library
1npm install @google-cloud/pubsub
Using the client library
1// Imports the Google Cloud client library 2const {PubSub} = require('@google-cloud/pubsub'); 3 4async function quickstart( 5 projectId = 'your-project-id', // Your Google Cloud Platform project ID 6 topicNameOrId = 'my-topic', // Name for the new topic to create 7 subscriptionName = 'my-sub' // Name for the new subscription to create 8) { 9 // Instantiates a client 10 const pubsub = new PubSub({projectId}); 11 12 // Creates a new topic 13 const [topic] = await pubsub.createTopic(topicNameOrId); 14 console.log(`Topic ${topic.name} created.`); 15 16 // Creates a subscription on that new topic 17 const [subscription] = await topic.createSubscription(subscriptionName); 18 19 // Receive callbacks for new messages on the subscription 20 subscription.on('message', message => { 21 console.log('Received message:', message.data.toString()); 22 process.exit(0); 23 }); 24 25 // Receive callbacks for errors on the subscription 26 subscription.on('error', error => { 27 console.error('Received error:', error); 28 process.exit(1); 29 }); 30 31 // Send a message to the topic 32 topic.publishMessage({data: Buffer.from('Test message!')}); 33} 34
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:
-
npm install grpc, addinggrpcas a dependency. -
instantiate
@google-cloud/pubsubwithgrpc:1const {PubSub} = require('@google-cloud/pubsub'); 2const grpc = require('grpc'); 3const 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 |  |
| Commit an Proto-Based Schema | source code | |
| Create an Avro based Schema | source code | |
| Create BigQuery Subscription | source code | |
| Create a Proto based Schema | source code | |
| Create Push Subscription | source code | |
| Create Push Subscription With No Wrapper | source code | |
| Create Subscription | source code | |
| Create a Cloud Storage subscription | source code | |
| Create Subscription With Dead Letter Policy | source code | |
| Create an exactly-once delivery subscription | source code | |
| Create Subscription With Filtering | source code | |
| Create Subscription with ordering enabled | source code | |
| Create Subscription With Retry Policy | source code | |
| Create Topic | source code | |
| Create Topic With Cloud Storage Ingestion | source code | |
| Create Topic With Kinesis Ingestion | source code | |
| Create Topic With Schema | source code | |
| Create Topic With Schema Revisions | source code | |
| Delete a previously created schema | source code | |
| Delete a Schema Revision | source code | |
| Delete Subscription | source code | |
| Delete Topic | source code | |
| Detach Subscription | source code | |
| Get a previously created schema | source code | |
| Get a previously created schema revision | source code | |
| Get Subscription | source code | |
| Get Subscription Policy | source code | |
| Get Topic Policy | source code | |
| List All Topics | source code | |
| List Revisions on a Schema | source code | |
| List schemas on a project | source code | |
| List Subscriptions | source code | |
| List Subscriptions On a Topic | source code | |
| Listen For Avro Records | source code | |
| Listen For Avro Records With Revisions | source code | |
| Listen For Errors | source code | |
| Listen For Messages | source code | |
| Listen with exactly-once delivery | source code | |
| Listen For Protobuf Messages | source code | |
| Listen For Messages With Custom Attributes | source code | |
| Subscribe with OpenTelemetry Tracing | source code | |
| Modify Push Configuration | source code | |
| Optimistic Subscribe | source code | |
| Publish Avro Records to a Topic | source code | |
| Publish Batched Messages | source code | |
| Publish Message | source code | |
| Publish Message With Custom Attributes | source code | |
| Publish Ordered Message | source code | |
| Publish Protobuf Messages to a Topic | source code | |
| Publish with flow control | source code | |
| Publish with OpenTelemetry Tracing | source code | |
| Publish With Retry Settings | source code | |
| Quickstart | source code | |
| Remove Dead Letter Policy | source code | |
| Resume Publish | source code | |
| Rollback a Schema | source code | |
| Set Subscription IAM Policy | source code | |
| Set Topic IAM Policy | source code | |
| Subscribe With Flow Control Settings | source code | |
| Synchronous Pull | source code | |
| Synchronous Pull with delivery attempt. | source code | |
| Synchronous Pull With Lease Management | source code | |
| Test Subscription Permissions | source code | |
| Test Topic Permissions | source code | |
| Update Dead Letter Policy | source code | |
| Update Topic Ingestion Type | source code | |
| Update Topic Schema | source code | |
| Validate a schema definition | source code | |
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
No vulnerabilities found.
Reason
28 commit(s) and 12 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
security policy file detected
Details
- Info: security policy file detected: SECURITY.md:1
- Info: Found linked content: SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1
- Info: Found text in security policy: SECURITY.md:1
Reason
all changesets reviewed
Reason
0 existing vulnerabilities detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0
Reason
SAST tool is not run on all commits -- score normalized to 4
Details
- Warn: 14 commits out of 30 are checked with a SAST tool
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/ci.yaml:1
- Warn: no topLevel permission defined: .github/workflows/issues-no-repro.yaml:1
- Warn: no topLevel permission defined: .github/workflows/response.yaml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/nodejs-pubsub/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/nodejs-pubsub/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/nodejs-pubsub/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/nodejs-pubsub/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/nodejs-pubsub/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/nodejs-pubsub/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/nodejs-pubsub/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/nodejs-pubsub/ci.yaml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yaml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/nodejs-pubsub/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/issues-no-repro.yaml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/nodejs-pubsub/issues-no-repro.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/issues-no-repro.yaml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/nodejs-pubsub/issues-no-repro.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/response.yaml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/nodejs-pubsub/response.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/response.yaml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/nodejs-pubsub/response.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/response.yaml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/nodejs-pubsub/response.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/response.yaml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/nodejs-pubsub/response.yaml/main?enable=pin
- Warn: npmCommand not pinned by hash: .kokoro/docs.sh:23
- Warn: npmCommand not pinned by hash: .kokoro/lint.sh:23
- Warn: npmCommand not pinned by hash: .kokoro/lint.sh:29
- Warn: npmCommand not pinned by hash: .kokoro/publish.sh:29
- Warn: npmCommand not pinned by hash: .kokoro/release/docs-devsite.sh:27
- Warn: npmCommand not pinned by hash: .kokoro/release/docs-devsite.sh:28
- Warn: npmCommand not pinned by hash: .kokoro/release/docs.sh:27
- Warn: npmCommand not pinned by hash: .kokoro/release/docs.sh:31
- Warn: npmCommand not pinned by hash: .kokoro/samples-test.sh:35
- Warn: npmCommand not pinned by hash: .kokoro/samples-test.sh:40
- Warn: npmCommand not pinned by hash: .kokoro/system-test.sh:34
- Warn: npmCommand not pinned by hash: .kokoro/test.sh:23
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:23
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:26
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:48
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:57
- Info: 0 out of 14 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 third-party GitHubAction dependencies pinned
- Info: 0 out of 16 npmCommand dependencies pinned
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Score
6.8
/10
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn MoreOther packages similar to @google-cloud/pubsub
mock-google-cloud-pubsub
mock @google-cloud/pubsub package in integration tests
nestjs-google-pubsub
Subscribe to Google Cloud PubSub topics using NestJS's EventMessage handlers.
@algoan/nestjs-google-pubsub-client
A NestJS ClientProxy for Google Cloud PubSub
@join-com/pubsub
Google Cloud PubSub wrapper