gRPC utility library for loading .proto files
Last updated 3 months ago by murgatroid99 .
Apache-2.0 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @grpc/proto-loader 
SYNC missed versions from official npm registry.

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.


npm install @grpc/proto-loader


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-pre6                                ...           generator-draft (2 days ago)
  • 0.5.4                                ...           latest (3 months ago)

14 Versions

  • 0.6.0-pre6                                ...           2 days ago
  • 0.6.0-pre5                                ...           13 days ago
  • 0.6.0-pre4                                ...           14 days ago
  • 0.6.0-pre3                                ...           20 days ago
  • 0.6.0-pre2                                ...           a month ago
  • 0.6.0-pre1                                ...           a month ago
  • 0.5.4                                ...           3 months ago
  • 0.5.3                                ...           8 months ago
  • 0.5.2                                ...           10 months ago
  • 0.5.1                                ...           a year ago
  • 0.5.0                                ...           a year ago
  • 0.4.0                                ...           a year ago
  • 0.3.0                                ...           2 years ago
  • 0.1.0                                ...           2 years ago
Today 382
This Week 1,266
This Month 2,672
Last Day 517
Last Week 2,199
Last Month 8,821
Dependencies (2)
Dev Dependencies (5)
Dependents (379)

Copyright 2014 - 2016 © taobao.org |