From 9da1bb14c4c58cb34fd855ff0e9b591dbdbecae3 Mon Sep 17 00:00:00 2001 From: murgatroid99 Date: Mon, 9 Jul 2018 14:38:43 -0700 Subject: [PATCH] proto loader: make options properly optional. +minor documentation fix --- packages/grpc-protobufjs/README.md | 4 ++-- packages/grpc-protobufjs/package.json | 2 +- packages/grpc-protobufjs/src/index.ts | 10 ++++++---- 3 files changed, 9 insertions(+), 7 deletions(-) diff --git a/packages/grpc-protobufjs/README.md b/packages/grpc-protobufjs/README.md index 307c635c..651da848 100644 --- a/packages/grpc-protobufjs/README.md +++ b/packages/grpc-protobufjs/README.md @@ -17,11 +17,11 @@ const grpcLibrary = require('grpc'); const grpcLibrary = require('@grpc/grpc-js'); protoLoader.load(protoFileName, options).then(packageDefinition => { - const package = grpcLibrary.loadPackageDefinition(packageDefinition); + const packageObject = grpcLibrary.loadPackageDefinition(packageDefinition); }); // OR const packageDefinition = protoLoader.loadSync(protoFileName, options); -const package = grpcLibrary.loadPackageDefinition(packageDefinition); +const packageObject = grpcLibrary.loadPackageDefinition(packageDefinition); ``` The options parameter is an object that can have the following optional properties: diff --git a/packages/grpc-protobufjs/package.json b/packages/grpc-protobufjs/package.json index 8890edb8..ebe82a43 100644 --- a/packages/grpc-protobufjs/package.json +++ b/packages/grpc-protobufjs/package.json @@ -1,6 +1,6 @@ { "name": "@grpc/proto-loader", - "version": "0.2.0", + "version": "0.3.0", "author": "Google Inc.", "contributors": [ { diff --git a/packages/grpc-protobufjs/src/index.ts b/packages/grpc-protobufjs/src/index.ts index 5f443f98..bb757762 100644 --- a/packages/grpc-protobufjs/src/index.ts +++ b/packages/grpc-protobufjs/src/index.ts @@ -156,8 +156,9 @@ function addIncludePathResolver(root: Protobuf.Root, includePaths: string[]) { * name * @param options.includeDirs Paths to search for imported `.proto` files. */ -export function load(filename: string, options: Options): Promise { +export function load(filename: string, options?: Options): Promise { const root: Protobuf.Root = new Protobuf.Root(); + options = options || {}; if (!!options.includeDirs) { if (!(options.includeDirs instanceof Array)) { return Promise.reject(new Error('The includeDirs option must be an array')); @@ -166,12 +167,13 @@ export function load(filename: string, options: Options): Promise { loadedRoot.resolveAll(); - return createPackageDefinition(root, options); + return createPackageDefinition(root, options!); }); } -export function loadSync(filename: string, options: Options): PackageDefinition { +export function loadSync(filename: string, options?: Options): PackageDefinition { const root: Protobuf.Root = new Protobuf.Root(); + options = options || {}; if (!!options.includeDirs) { if (!(options.includeDirs instanceof Array)) { throw new Error('The include option must be an array'); @@ -180,5 +182,5 @@ export function loadSync(filename: string, options: Options): PackageDefinition } const loadedRoot = root.loadSync(filename, options); loadedRoot.resolveAll(); - return createPackageDefinition(root, options); + return createPackageDefinition(root, options!); }