Clarify access to requestData properties #1063
Merged
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.
requestData
classes have a number of internal properties. However, I don't think it's as clear as it could be that these properties are internal. This came up recently at #1024 (comment). I tried to make the properties private (that would be really clear), but that didn't work for a couple of reasons. Instead, I added a comment explaining our use of Symbol properties.I also renamed the
_name
property toresourceName
. I think it was particularly unclear whether that property was internal. Its name starts with_
, but it's not a Symbol, and it's also intended to be used outside the file it's defined in. (Or if not used, at least included inconsole.log()
output.) I think it doesn't hurt to remove the underscore and make it explicit how the property is meant to be used and that it's OK to use the property outside the file.What has been done to verify that this works as intended?
Tests continue to pass.
Before submitting this PR, please make sure you have:
npm run test
andnpm run lint
and confirmed all checks still pass OR confirm CircleCI build passes