@google-cloud/pubsub-api 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,111 @@
1
+ [//]: # "This README.md file is auto-generated, all changes to this file will be lost."
2
+ [//]: # "The comments you see below are used to generate those parts of the template in later states."
3
+ <img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
4
+
5
+ # [Cloud Pub/Sub API: Nodejs Client][homepage]
6
+
7
+ > [!IMPORTANT]
8
+ > **Internal API Client**: This library (`@google-cloud/pubsub-api`) is an auto-generated, lightweight GAPIC layer designed as a dependency for the official handwritten client library. End users should install and import **[@google-cloud/pubsub](https://www.npmjs.com/package/@google-cloud/pubsub)** instead.
9
+
10
+ [//]: # "releaseLevel"
11
+
12
+ [![npm version](https://img.shields.io/npm/v/@google-cloud/pubsub-api.svg)](https://www.npmjs.org/package/@google-cloud/pubsub-api)
13
+
14
+ Cloud Pub/Sub API client for Node.js
15
+
16
+ [//]: # "partials.introduction"
17
+
18
+ A comprehensive list of changes in each version may be found in
19
+ [the CHANGELOG][homepage_changelog].
20
+
21
+ * [Cloud Pub/Sub API Nodejs Client API Reference](https://cloud.google.com/nodejs/docs/reference/pubsub/latest)
22
+ * [Cloud Pub/Sub API Documentation](https://cloud.google.com/pubsub/docs)
23
+
24
+ Read more about the client libraries for Cloud APIs, including the older
25
+ Google APIs Client Libraries, in [Client Libraries Explained][explained].
26
+
27
+ [explained]: https://cloud.google.com/apis/docs/client-libraries-explained
28
+
29
+ **Table of contents:**
30
+
31
+ * [Quickstart](#quickstart)
32
+ * [Before you begin](#before-you-begin)
33
+ * [Installing the client library](#installing-the-client-library)
34
+
35
+ * [Versioning](#versioning)
36
+ * [Contributing](#contributing)
37
+ * [License](#license)
38
+
39
+ ## Quickstart
40
+ ### Before you begin
41
+
42
+ 1. [Select or create a Cloud Platform project][projects].
43
+ 1. [Enable billing for your project][billing].
44
+ 1. [Enable the Cloud Pub/Sub API API][enable_api].
45
+ 1. [Set up authentication][auth] so you can access the
46
+ API from your local workstation.
47
+ ### Installing the client library
48
+
49
+ ```bash
50
+ npm install @google-cloud/pubsub-api
51
+ ```
52
+
53
+ [//]: # "partials.body"
54
+
55
+ ## Samples
56
+
57
+ Samples are in the [`samples/`][homepage_samples] directory. Each sample's `README.md` has instructions for running its sample.
58
+
59
+ [//]: # "samples"
60
+
61
+ ## Supported Node.js Versions
62
+
63
+ Our client libraries follow the [Node.js release schedule](https://github.com/nodejs/release#release-schedule).
64
+ Libraries are compatible with all current _active_ and _maintenance_ versions of
65
+ Node.js.
66
+ If you are using an end-of-life version of Node.js, we recommend that you update
67
+ as soon as possible to an actively supported LTS version.
68
+
69
+ Google's client libraries support legacy versions of Node.js runtimes on a
70
+ best-efforts basis with the following warnings:
71
+
72
+ * Legacy versions are not tested in continuous integration.
73
+ * Some security patches and features cannot be backported.
74
+ * Dependencies cannot be kept up-to-date.
75
+
76
+ Client libraries targeting some end-of-life versions of Node.js are available, and
77
+ can be installed through npm [dist-tags](https://docs.npmjs.com/cli/dist-tag).
78
+ The dist-tags follow the naming convention `legacy-(version)`.
79
+ For example, `npm install @google-cloud/pubsub-api@legacy-8` installs client libraries
80
+ for versions compatible with Node.js 8.
81
+
82
+ ## Versioning
83
+
84
+ This library follows [Semantic Versioning](http://semver.org/).
85
+
86
+ More Information: [Google Cloud Platform Launch Stages][launch_stages]
87
+
88
+ [launch_stages]: https://cloud.google.com/terms/launch-stages
89
+
90
+ ## Contributing
91
+
92
+ Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/CONTRIBUTING.md).
93
+
94
+ Please note that this `README.md`
95
+ and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)
96
+ are generated from a central template.
97
+
98
+ ## License
99
+
100
+ Apache Version 2.0
101
+
102
+ See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
103
+
104
+ [shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
105
+ [projects]: https://console.cloud.google.com/project
106
+ [billing]: https://support.google.com/cloud/answer/6293499#enable-billing
107
+ [enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=pubsub.googleapis.com
108
+ [auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local
109
+ [homepage_samples]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-pubsub/samples
110
+ [homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-pubsub/CHANGELOG.md
111
+ [homepage]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-pubsub