Merge pull request #558 from grpc/doc

Documentation updates.
This commit is contained in:
Nicolas Noble 2018-09-26 12:12:51 -07:00 committed by GitHub
commit cbe039ac52
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 1 deletions

View File

@ -101,6 +101,8 @@ var loadObject = exports.loadObject;
/**
* Load a gRPC object from a .proto file.
* @deprecated Use the {@link https://www.npmjs.com/package/@grpc/proto-loader|proto-loader module}
with grpc.loadPackageDefinition instead.
* @memberof grpc
* @alias grpc.load
* @param {string|{root: string, file: string}} filename The file to load
@ -376,4 +378,4 @@ exports.Channel = grpc.Channel;
* {@link grpc.propagate} that indicates what information to propagate
* from parentCall
* @return {grpc~Call}
*/
*/

View File

@ -1,6 +1,8 @@
# 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](https://github.com/dcodeIO/protobuf.js/blob/master/README.md)
to understands its features and limitations.
## Installation