google-proto-files

What is google-proto-files?

The google-proto-files npm package provides access to Google's Protocol Buffers (protobuf) files. These files define the structure of data used by Google's APIs and services. By using this package, developers can easily integrate with Google's APIs by leveraging the predefined protobuf files.

What are google-proto-files's main functionalities?

Accessing Google Protobuf Files

This feature allows you to access the path to Google's protobuf files. The code sample demonstrates how to require the google-proto-files package and retrieve the path to a specific protobuf file, in this case, 'timestamp.proto'.

const protoFiles = require('google-proto-files');
const path = protoFiles('google/protobuf/timestamp.proto');
console.log(path);

Integrating with Google APIs

This feature demonstrates how to integrate with Google APIs using the protobuf files provided by google-proto-files. The code sample shows how to load the 'cloud_speech.proto' file and create a gRPC client for the Google Cloud Speech API.

const grpc = require('@grpc/grpc-js');
const protoLoader = require('@grpc/proto-loader');
const protoFiles = require('google-proto-files');

const packageDefinition = protoLoader.loadSync(protoFiles('google/cloud/speech/v1/cloud_speech.proto'), {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true
});
const speechProto = grpc.loadPackageDefinition(packageDefinition).google.cloud.speech.v1;

const client = new speechProto.SpeechClient({
  // Client configuration
});

console.log(client);

Other packages similar to google-proto-files

@grpc/proto-loader

The @grpc/proto-loader package is used to load .proto files for use with gRPC in Node.js. It provides similar functionality to google-proto-files in terms of loading protobuf files, but it does not specifically provide access to Google's predefined protobuf files. Instead, it is a more general-purpose loader for any .proto files.

protobufjs

The protobufjs package is a comprehensive library for working with Protocol Buffers in JavaScript. It allows you to define, encode, decode, and verify protobuf messages. While it does not provide direct access to Google's protobuf files, it offers a wide range of features for working with protobufs in general.

README

googleapis Proto Files: Node.js Client

Get a copy of the googleapis proto files into your project.

• 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.

Table of contents:

• Usage
• Versioning
• Contributing
• License

Usage

$ npm install --save google-proto-files

var protoFiles = require('google-proto-files')

Get a directory path by executing as a function

protoFiles('logging', 'v2')
// node_modules/google-proto-files/google/logging/v2

Get a path to the entry proto file for a specific API version

protoFiles.pubsub.v1
// node_modules/google-proto-files/google/pubsub/v1/pubsub.proto

load|loadSync(fileName, [options])

options

Load a proto which depends on google common protos.

Asynchronously

protoFiles.load('path/to/file.proto').then(function(root) {
  var MyService = root.lookup('example.MyService')
})

Synchronously

var root = protoFiles.loadSync('path/to/file.proto');
var MyService = root.lookup('example.MyService');

Versioning

This library follows Semantic Versioning.

This library is considered to be in alpha. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

License

Apache Version 2.0

See LICENSE