Skip to content

doc: fix CryptoKey.algorithm type and other interfaces in webcrypto.md #58294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 14, 2025

Conversation

panva
Copy link
Member

@panva panva commented May 12, 2025

This PR is a followup to #57376

  • replaces the AlgorithmIdentifier used as type with its extended but more granular and node-doc-like type string|Algorithm
  • fixes cryptoKey.algorithm to include KeyAlgorithm and use the "*KeyAlgorithm" interfaces rather then "*GenParams" or "*ImportParams" interfaces
  • use Algorithm interface instead of generic Object in various hashed algorithm interfaces

Reminder: the classes referred to in webcrypto.md docs are mere WebIDL interfaces/dictionaries taken from the Web Cryptography API spec, apart from CryptoKey these are not actual classes.

@panva panva added crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. webcrypto labels May 12, 2025
@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/crypto
  • @nodejs/web-infra

Copy link
Member

@lpinca lpinca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

RSLGTM

flakey5 added a commit to nodejs/api-docs-tooling that referenced this pull request May 12, 2025
Mirrors changes in nodejs/node#58294

Signed-off-by: flakey5 <[email protected]>

Co-authored-by: Filip Skokan <[email protected]>
@panva panva added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 12, 2025
@panva panva added the commit-queue Add this label to land a pull request using GitHub Actions. label May 13, 2025
@panva panva added commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. and removed commit-queue Add this label to land a pull request using GitHub Actions. author ready PRs that have at least one approval, no pending requests for changes, and a CI started. labels May 13, 2025
@panva panva added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue Add this label to land a pull request using GitHub Actions. labels May 14, 2025
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label May 14, 2025
@nodejs-github-bot nodejs-github-bot merged commit 1ad8b05 into nodejs:main May 14, 2025
29 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in 1ad8b05

@panva panva deleted the fix-webcrypto-docs branch May 14, 2025 20:43
flakey5 added a commit to nodejs/api-docs-tooling that referenced this pull request May 15, 2025
* fix: CryptoKey.algorithm type and other interfaces

Mirrors changes in nodejs/node#58294

Signed-off-by: flakey5 <[email protected]>

Co-authored-by: Filip Skokan <[email protected]>

* Update src/utils/parser/constants.mjs

Co-authored-by: Filip Skokan <[email protected]>

---------

Co-authored-by: Filip Skokan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory. webcrypto
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants