Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/googleapis/nodejs-proto-files
All of the Google API's protocol buffer files
https://github.com/googleapis/nodejs-proto-files
Last synced: 9 days ago
JSON representation
All of the Google API's protocol buffer files
- Host: GitHub
- URL: https://github.com/googleapis/nodejs-proto-files
- Owner: googleapis
- License: apache-2.0
- Created: 2016-01-18T21:44:47.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2024-05-16T13:55:11.000Z (6 months ago)
- Last Synced: 2024-05-18T15:45:08.708Z (6 months ago)
- Language: TypeScript
- Size: 968 KB
- Stars: 74
- Watchers: 44
- Forks: 20
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Authors: AUTHORS
Awesome Lists containing this project
- awesome-grpc - Node.js Proto Files - All of the Google API's protocol buffer files (Language-Specific / Node.js)
README
[//]: # "This README.md file is auto-generated, all changes to this file will be lost."
[//]: # "To regenerate it, use `python -m synthtool`."
# [Google APIs Proto Files: Node.js Client](https://github.com/googleapis/nodejs-proto-files)
[](https://cloud.google.com/terms/launch-stages)
[](https://www.npmjs.org/package/google-proto-files)
All of the Google API's protocol buffer files
A comprehensive list of changes in each version may be found in
[the CHANGELOG](https://github.com/googleapis/nodejs-proto-files/blob/main/CHANGELOG.md).
* [Google APIs Proto Files Node.js Client API Reference][client-docs]
* [github.com/googleapis/nodejs-proto-files](https://github.com/googleapis/nodejs-proto-files)
Read more about the client libraries for Cloud APIs, including the older
Google APIs Client Libraries, in [Client Libraries Explained][explained].
[explained]: https://cloud.google.com/apis/docs/client-libraries-explained
**Table of contents:**
* [Quickstart](#quickstart)
* [Installing the client library](#installing-the-client-library)
* [Using the client library](#using-the-client-library)
* [Samples](#samples)
* [Versioning](#versioning)
* [Contributing](#contributing)
* [License](#license)
## Quickstart
### Installing the client library
```bash
npm install google-proto-files
```
### Using the client library
```javascript
const protos = require('google-proto-files');
async function quickstart() {
// Get a directory path by executing as a function
const files = protos.getProtoPath('logging', 'v2');
console.log(files);
// node_modules/google-proto-files/google/logging/v2
// Get a path to the entry proto file for a specific API version
console.log(protos.pubsub.v1);
// node_modules/google-proto-files/google/pubsub/v1/pubsub.proto
// Load a proto which depends on google common protos.
const root1 = await protos.load('./cloudcats.proto');
const service1 = root1.lookup('example.MyService');
console.log(service1);
// Load protos synchronously
const root2 = protos.loadSync('./cloudcats.proto');
const service2 = root2.lookup('example.MyService');
console.log(service2);
}
quickstart();
```
## Samples
Samples are in the [`samples/`](https://github.com/googleapis/nodejs-proto-files/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample.
| Sample | Source Code | Try it |
| --------------------------- | --------------------------------- | ------ |
| Quickstart | [source code](https://github.com/googleapis/nodejs-proto-files/blob/main/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-proto-files&page=editor&open_in_editor=samples/quickstart.js,samples/README.md) |
The [Google APIs Proto Files Node.js Client API Reference][client-docs] documentation
also contains samples.
## Supported Node.js Versions
Our client libraries follow the [Node.js release schedule](https://github.com/nodejs/release#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](https://docs.npmjs.com/cli/dist-tag).
The dist-tags follow the naming convention `legacy-(version)`.
For example, `npm install google-proto-files@legacy-8` installs client libraries
for versions compatible with Node.js 8.
## Versioning
This library follows [Semantic Versioning](http://semver.org/).
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][launch_stages]
[launch_stages]: https://cloud.google.com/terms/launch-stages
## Contributing
Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/nodejs-proto-files/blob/main/CONTRIBUTING.md).
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](https://github.com/googleapis/synthtool).
## License
Apache Version 2.0
See [LICENSE](https://github.com/googleapis/nodejs-proto-files/blob/main/LICENSE)
[client-docs]: https://cloud.google.com/nodejs/docs/reference/google-proto-files/latest
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
[projects]: https://console.cloud.google.com/project
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local