grpc-pbf-loader
TypeScript icon, indicating that this package has built-in type declarations

1.1.6 • Public • Published

grpc-pbf-loader

npm version npm downloads

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

Installation

npm i grpc-pbf-loader

Usage

const packageDefinitionLoader = require("grpc-pbf-loader").packageDefinition;
const grpcLibrary = require("grpc");
// OR
const grpcLibrary = require("@grpc/grpc-js");

const packageDefinition = await packageDefinitionLoader.load(protoFileName, options);
const packageObject = grpcLibrary.loadPackageDefinition(packageDefinition);
// OR
const packageDefinition = packageDefinitionLoader.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.
includeDirs An array of strings A list of search paths for imported .proto files.

Readme

Keywords

Package Sidebar

Install

npm i grpc-pbf-loader

Weekly Downloads

8

Version

1.1.6

License

MIT

Unpacked Size

173 kB

Total Files

37

Last publish

Collaborators

  • dmitriy.litichevskiy