grpc-node/packages/proto-loader
Natan Sągol 8cbda9b03c
build(proto-loader): add full gts configuration and fix reported issues
2019-11-08 08:09:40 +01:00
..
src build(proto-loader): add full gts configuration and fix reported issues 2019-11-08 08:09:40 +01:00
test build(proto-loader): add full gts configuration and fix reported issues 2019-11-08 08:09:40 +01:00
test_protos proto-loader: include Google well known protos 2019-04-01 16:29:26 -04:00
LICENSE Don't fill in any templates in LICENSE files 2019-03-06 11:01:44 -08:00
README.md proto-loader: rename grpc-protobufjs to match npm 2018-11-01 17:09:28 -04:00
gulpfile.ts Fix missing clean deps 2019-04-24 17:06:23 -07:00
package.json build(proto-loader): add full gts configuration and fix reported issues 2019-11-08 08:09:40 +01:00
prettier.config.js build(proto-loader): add full gts configuration and fix reported issues 2019-11-08 08:09:40 +01:00
tsconfig.json build(proto-loader): add full gts configuration and fix reported issues 2019-11-08 08:09:40 +01:00
tslint.json build(proto-loader): add full gts configuration and fix reported issues 2019-11-08 08:09:40 +01:00

README.md

gRPC Protobuf Loader

A utility package for loading .proto files for use with gRPC, using the latest Protobuf.js package. Please refer to protobuf.js' documentation to understands its features and limitations.

Installation

npm install @grpc/proto-loader

Usage

const protoLoader = require('@grpc/proto-loader');
const grpcLibrary = require('grpc');
// OR
const grpcLibrary = require('@grpc/grpc-js');

protoLoader.load(protoFileName, options).then(packageDefinition => {
  const packageObject = grpcLibrary.loadPackageDefinition(packageDefinition);
});
// OR
const packageDefinition = protoLoader.loadSync(protoFileName, options);
const packageObject = grpcLibrary.loadPackageDefinition(packageDefinition);

The options parameter is an object that can have the following optional properties:

Field name Valid values Description
keepCase true or false Preserve field names. The default is to change them to camel case.
longs String or Number The type to use to represent long values. Defaults to a Long object type.
enums String The type to use to represent enum values. Defaults to the numeric value.
bytes Array or String The type to use to represent bytes values. Defaults to Buffer.
defaults true or false Set default values on output objects. Defaults to false.
arrays true or false Set empty arrays for missing array values even if defaults is false Defaults to false.
objects true or false Set empty objects for missing object values even if defaults is false Defaults to false.
oneofs true or false Set virtual oneof properties to the present field's name. Defaults to false.
includeDirs An array of strings A list of search paths for imported .proto files.

The following options object closely approximates the existing behavior of grpc.load:

const options = {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true
}