grpc-pbf-loader

A utility package for loading .proto files for use with gRPC, using pbf as a serializer.

Installation

1npm i grpc-pbf-loader

Usage

1const packageDefinitionLoader = require("grpc-pbf-loader").packageDefinition;
2const grpcLibrary = require("grpc");
3// OR
4const grpcLibrary = require("@grpc/grpc-js");
5
6const packageDefinition = await packageDefinitionLoader.load(protoFileName, options);
7const packageObject = grpcLibrary.loadPackageDefinition(packageDefinition);
8// OR
9const packageDefinition = packageDefinitionLoader.loadSync(protoFileName, options);
10const 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.
includeDirs	An array of strings	A list of search paths for imported .proto files.