Add JSDoc documentation and universal exports #30
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
This commit introduces two key improvements to the Blake2B implementation: 1. Comprehensive JSDoc Documentation: - Added JSDoc comments for all functions and classes - Documented parameters, return values, and exceptions - Maintained all original inline comments and explanations - Added type information for better IDE support - Documented the Blake namespace and its methods - Improved input parameter documentation for normalizeInput() 2. Universal Export Pattern: - Added robust environment detection for exports - Supports CommonJS (Node.js), AMD, and browser globals - Uses globalThis with fallbacks to window/self - Maintains backward compatibility - Provides cleaner consumption in all environments The original functionality remains completely unchanged - these are improvements to documentation and module exports. All original comments from the reference implementation have been preserved exactly as they were, including: - RFC reference comments - Performance optimization notes - Debugging helper comments - Example usage in comments - Core algorithm explanations The changes make the code: - Better documented for maintainers - More tooling-friendly (IDEs, TypeScript) - Easier to consume in different environments - More future-proof while maintaining compatibility
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 commit introduces two key improvements to the Blake2B implementation:
The original functionality remains completely unchanged - these are improvements to documentation and module exports.
All original comments from the reference implementation have been preserved exactly as they were, including:
The changes make the code: