Correctly Specify StreamManagerClient Logger Type #20
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
StreamManagerClient expects an optional Logger within its constructor.
The Logger type definition does not include a property
warn, which isexpected by the StreamManagerClient.
This commit adds a property
warnto the JSDoc typedef forStreamManagerClient's Logger to reduce the likelihood of users supplying
an invalid Logger.
Resolves #19