This repository was archived by the owner on Aug 11, 2021. It is now read-only.
Required callbacks for user & hostname #8
Conversation
This file contains hidden or 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
martinheidegger
changed the title
Author
|
@iarna I updated the description to this PR. I hope it is more explanatory now. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
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.
This PR proposes a fix to an issue/bug in the osenv API.
Both the
userandhostnamemethods can optionally fallback to the executables:whoamiandhostname. If a fallback happens, that fallback will be async. In other words, depending on the environmentuser = osenv.user()may or may-not work as intended.osenv.user((err, user) => {}will always work as intended with the fallback. The important thing here is that the user will not notice the error.To mitigate this, this PR uses a soft-breaking API.
osenv.user()andosenv.hostname()will always returnundefined. With a callback it will work, consistently.An alternative solution to this would be to throw an error if no callback is given and/or write a deprecation warning.