Skip to content

Commit

Permalink
Correctly Specify StreamManagerClient Logger Type
Browse files Browse the repository at this point in the history
StreamManagerClient expects an optional Logger within its constructor.
The Logger type definition does not include a property `warn`, which is
expected by the StreamManagerClient.

This commit adds a property `warn` to the JSDoc typedef for
StreamManagerClient's Logger to reduce the likelihood of users supplying
an invalid Logger.

Resolves aws#19
  • Loading branch information
lummish committed Jan 20, 2021
1 parent 0dcbd0b commit c1ab248
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions aws-greengrass-core-sdk/stream-manager/client.js
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ class StreamManagerClient {
* @typedef Logger
* @type {Object}
* @property {function(...*)} error
* @property {function(...*)} warn
* @property {function(...*)} info
* @property {function(...*)} debug
*/
Expand Down

0 comments on commit c1ab248

Please sign in to comment.