New function names for clarity #14
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 function names `v()` and `p()` in this library were accidentally reversed from the tradition. Since the function names might be a bit confusing even if named correctly, we should rename them as `acquire()` and `release()` but also provide the old names for backwards compatibility. Fixes #13
pranaygp
suggested changes
Mar 17, 2018
index.d.ts
Outdated
|
|
||
| v(): Promise<string>; | ||
|
|
||
| acquire(token?: string): void; |
There was a problem hiding this comment.
This seems incorrect @OlliV
should it not be acquire(): Promise<string>?
There was a problem hiding this comment.
That's correct, thanks.
leo
approved these changes
Mar 18, 2018
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
The function names
v()andp()in this library wereaccidentally reversed from the tradition. Since the function names
might be a bit confusing even if named correctly, we should rename
them as
acquire()andrelease()but also provide the old namesfor backwards compatibility.
Fixes #13