docs: align Buffer wording with Uint8Array-first v7 APIs#2325
Open
lindsey-comet wants to merge 1 commit intobitcoinjs:masterfrom
Open
docs: align Buffer wording with Uint8Array-first v7 APIs#2325lindsey-comet wants to merge 1 commit intobitcoinjs:masterfrom
lindsey-comet wants to merge 1 commit intobitcoinjs:masterfrom
Conversation
Updated README.md and JSDoc comments to reflect that v7 APIs are Uint8Array-first. Buffer input is still accepted (as it is a Uint8Array subclass), but the canonical public type is now Uint8Array. Changes: - README.md: Updated project description to mention Uint8Array - JSDoc comments: Changed 'as a Buffer' to 'as a Uint8Array' or clarified Buffer compatibility notes Fixes bitcoinjs#2321
|
duplicate of #2322 ? |
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
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.
Summary
Updated README.md and JSDoc comments to reflect that v7 APIs are Uint8Array-first. The documentation now consistently describes Uint8Array as the canonical public type while keeping explicit compatibility notes where Buffer input is accepted.
Changes
Acceptance
Fixes #2321