fix: expose tech but warn without safety var #3916
Merged
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
|
The tests need to be updated. |
dmlap
reviewed
Jan 4, 2017
| throw new Error(errorText); | ||
| if (!safety) { | ||
| const warnText = ` | ||
| Using the tech directly can be dangerous. I hope you know what you're doing. |
|
LGTM |
misteroneill
reviewed
Jan 5, 2017
| See https://github.com/videojs/video.js/issues/2617 for more info. | ||
| `; | ||
|
|
||
| log.warn(warnText); |
There was a problem hiding this comment.
The variable seems superfluous. Is there a reason not to pass a string directly to warn()?
| throw new Error(errorText); | ||
| if (!safety) { | ||
| log.warn(` | ||
| Using the tech directly can be dangerous. I hope you know what you're doing. |
There was a problem hiding this comment.
won't this add lots of whitespace to the start of the warning?
| * @param {boolean} safety.IWillNotUseThisInPlugins | ||
| * Must be set to true or else this function will throw an error. | ||
| * @param {Any} safety | ||
| * Anything passed in to silence the warning |
There was a problem hiding this comment.
technically it will have to be a true value, due to the if check (we may want to check if it is === undefined below)
| * | ||
| * @param {boolean} safety.IWillNotUseThisInPlugins | ||
| * Must be set to true or else this function will throw an error. | ||
| * @param {Any} safety |
There was a problem hiding this comment.
I think that the type here should actually be *. https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler#the-all-type
There was a problem hiding this comment.
changed it to * and also made it optional via [safety].
brandonocasey
approved these changes
Jan 5, 2017
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.
No description provided.