0.0.1 • Published 4 years ago

@fangjinlyx/proto-loader v0.0.1

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
4 years ago

完全基于@grpc/proto-loader#0.5.5

私人定制: 1. 新增loadSyncWithRoot,额外返回Protobuf.Root

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 nameValid valuesDescription
keepCasetrue or falsePreserve field names. The default is to change them to camel case.
longsString or NumberThe type to use to represent long values. Defaults to a Long object type.
enumsStringThe type to use to represent enum values. Defaults to the numeric value.
bytesArray or StringThe type to use to represent bytes values. Defaults to Buffer.
defaultstrue or falseSet default values on output objects. Defaults to false.
arraystrue or falseSet empty arrays for missing array values even if defaults is false Defaults to false.
objectstrue or falseSet empty objects for missing object values even if defaults is false Defaults to false.
oneofstrue or falseSet virtual oneof properties to the present field's name. Defaults to false.
includeDirsAn array of stringsA 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
}