This repository has been archived by the owner on Sep 23, 2021. It is now read-only.
clarify use of path for sidedoor.get #2
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
If using a path to locate the module,
sidedoor.getcurrently requires the module pathname to be written relative from the location ofsidedoor.js. For example, ifsidedooris installed via npm, then a module at the root project folder would need to be referenced this way:sidedoor.get('../../../my-module'). This is becauserequire.resolveis called from within that file.This issue can be avoided by simply passing in an absolute path. The distinction is clarified in the README and an example provided on how to pass an absolute path.