docs: describe parameter types & instruct TS usage #74
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 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.
When I was reading current README in a hurry, I felt like the current instructions are ambiguous, e.g. as if the
'42'parameter is some length and'hex'is a value to be converted. The list of supported algorithms also has to be deduced with some assumptions. My suggestion is to solve all these issues together by explicitly documenting the type of this library interface for any newcomers, possibly along with a reminder that the@types/sha.jslibrary is also available (it feels like the "on pure JavaScript" description implies otherwise).The
algorithmparameter is however typed asstringright now; I've prepared a PR to address this in DefinitelyTyped/DefinitelyTyped#59757