deprecation(crypto): rename an export to match style guide, deprecating original and two other obsolete imports #4525
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
…ginal and two other obsolete imports
kt3k
reviewed
Mar 26, 2024
kt3k
changed the title
iuioiua
reviewed
Mar 27, 2024
| * | ||
| * @deprecated (will be removed in 1.0.0) Consider using {@linkcode DIGEST_ALGORITHM_NAMES} instead. | ||
| */ | ||
| export const wasmDigestAlgorithms = DIGEST_ALGORITHM_NAMES; |
There was a problem hiding this comment.
| * A FNV (Fowler/Noll/Vo) digest algorithm name supported by std/crypto. | ||
| * | ||
| * @deprecated (will be removed in 1.0.0) | ||
| */ | ||
| export type FNVAlgorithms = "FNV32" | "FNV32A" | "FNV64" | "FNV64A"; |
There was a problem hiding this comment.
The use of this export is minimal. A removal version of v1 instead of sooner is overkill and would be non-impactful to remove sooner. See https://github.com/search?q=%22FNVAlgorithms%22&type=code and notice they're almost entirely forks of std. WDYT, @kt3k?
There was a problem hiding this comment.
There's no benefit of removing them earlier in my view.
Breaking at 1.0 is more obvious and less confusing. That is better than breaking at random 0.x version in my view
| * | ||
| * @deprecated (will be removed in 1.0.0) Consider using {@linkcode DigestAlgorithmName} instead. | ||
| */ | ||
| export type WasmDigestAlgorithm = DigestAlgorithmName; |
There was a problem hiding this comment.
eryue0220
added a commit
to eryue0220/deno_std
that referenced
this pull request
Mar 30, 2024
…220/deno_std into feat/expect-addSnapshotSerializer * 'feat/expect-addSnapshotSerializer' of github.com:eryue0220/deno_std: deprecation(crypto): rename an export to match style guide, deprecating original and two other obsolete imports (denoland#4525) chore: add `--allow-dirty` flag to publish dry run (denoland#4535) [unstable] BREAKING(semver): remove comparator.semver field (denoland#4533) chore(crypto): upgrade dependencies (denoland#4530) 0.221.0 (denoland#4531) docs(fs): polish documentation (denoland#4526) fix(fs): `SubdirectoryMoveError` extends `Error` correctly (denoland#4528) chore(fs): remove `test.ts` (denoland#4527)
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.
(Originally part of #4515, broken into separate PR as suggested by iuioiua.)
This PR renames
crypto.ts's exportedconstwasmDigestAlgorithmstoDIGEST_ALGORITHM_NAMES, to match Deno's style guide and reflect the fact that it includes all algorithm names supported by the digest function, not just a subset. The old name is maintained as a deprecated alias for now. The exportedWasmDigestAlgorithmtype is deprecated, as it's redundant with the existingDigestAlgorithmNameexport (all algorithms are available in Wasm, and if that changes in the future it should probably just be an internal implementation detail, not part of the public interface). TheFNVAlgorithmsexport is similarly deprecated (they were previously a special case that was not included in Wasm).