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`.
`json`	`true` or `false`	Represent `Infinity` and `NaN` as strings in `float` fields, and automatically decode `google.protobuf.Any` values. 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
}

Current Tags

0.6.0-pre18 ... generator-draft (4 years ago)
0.7.13 ... latest (6 months ago)
0.7.9-pre.1 ... prerelease (a year ago)

57 Versions

0.7.13 ... 6 months ago
0.7.12 ... 8 months ago
0.7.11 ... 8 months ago
0.7.10 ... a year ago
0.7.9 ... a year ago
0.7.9-pre.1 ... a year ago
0.7.8 ... a year ago
0.7.7 ... 2 years ago
0.7.6 ... 2 years ago
0.7.5 ... 2 years ago
0.7.4 ... 2 years ago
0.7.3 ... 2 years ago
0.7.2 ... 2 years ago
0.7.1 ... 2 years ago
0.7.0 ... 2 years ago
0.6.13 ... 2 years ago
0.6.12 ... 3 years ago
0.6.11 ... 3 years ago
0.6.10 ... 3 years ago
0.6.9 ... 3 years ago
0.6.8 ... 3 years ago
0.6.7 ... 3 years ago
0.6.6 ... 3 years ago
0.6.5 ... 3 years ago
0.6.4 ... 3 years ago
0.6.3 ... 3 years ago
0.6.2 ... 4 years ago
0.6.1 ... 4 years ago
0.6.0 ... 4 years ago
0.6.0-pre18 ... 4 years ago
0.5.6 ... 4 years ago
0.6.0-pre17 ... 4 years ago
0.6.0-pre16 ... 4 years ago
0.6.0-pre15 ... 4 years ago
0.6.0-pre14 ... 4 years ago
0.6.0-pre13 ... 4 years ago
0.6.0-pre12 ... 4 years ago
0.6.0-pre11 ... 4 years ago
0.6.0-pre10 ... 4 years ago
0.6.0-pre9 ... 4 years ago
0.6.0-pre8 ... 4 years ago
0.5.5 ... 4 years ago
0.6.0-pre7 ... 4 years ago
0.6.0-pre6 ... 4 years ago
0.6.0-pre5 ... 4 years ago
0.6.0-pre4 ... 4 years ago
0.6.0-pre3 ... 4 years ago
0.6.0-pre2 ... 4 years ago
0.6.0-pre1 ... 4 years ago
0.5.4 ... 5 years ago
0.5.3 ... 5 years ago
0.5.2 ... 5 years ago
0.5.1 ... 5 years ago
0.5.0 ... 6 years ago
0.4.0 ... 6 years ago
0.3.0 ... 6 years ago
0.1.0 ... 7 years ago