Skip to content

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

Merged
nodejs-github-bot merged 2 commits into
nodejs:mainfrom
panva:fix-webcrypto-docs
May 14, 2025
Merged

doc: fix CryptoKey.algorithm type and other interfaces in webcrypto.md#58294
nodejs-github-bot merged 2 commits into
nodejs:mainfrom
panva:fix-webcrypto-docs

Conversation

@panva

@panvapanva commented May 12, 2025•
edited
Loading

Copy link
Copy Markdown
Member

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.

@panvapanva 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

nodejs-github-bot commented May 12, 2025

Copy link
Copy Markdown
Collaborator

Review requested:

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

@nodejs-github-botnodejs-github-bot added the tools Issues and PRs related to the tools directory. label May 12, 2025
@panvapanva mentioned this pull request May 12, 2025
Closed
lpinca
lpinca approved these changes May 12, 2025
View reviewed changes

@lpincalpinca left a comment

Copy link
Copy Markdown
Member

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/doc-kit that referenced this pull request May 12, 2025
@flakey5@panva
fix: CryptoKey.algorithm type and other interfaces
d2e94b6
Mirrors changes in nodejs/node#58294
Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>
Co-authored-by: Filip Skokan <panva.ip@gmail.com>
@flakey5flakey5 mentioned this pull request May 12, 2025
Merged
@panvapanva added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 12, 2025
@panvapanva added the commit-queue Add this label to land a pull request using GitHub Actions. label May 13, 2025
panva
panva commented May 13, 2025
View reviewed changes
Comment threadtools/doc/type-parser.mjs Outdated
@panvapanva 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
@panvapanva 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-botnodejs-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:mainMay 14, 2025
@nodejs-github-bot

nodejs-github-bot commented May 14, 2025

Copy link
Copy Markdown
Collaborator

Landed in 1ad8b05

@panva
panva deleted the fix-webcrypto-docs branch May 14, 2025 20:43
flakey5 added a commit to nodejs/doc-kit that referenced this pull request May 15, 2025
@flakey5@panva
fix: CryptoKey.algorithm type and other interfaces (#270)
6f70de4
* fix: CryptoKey.algorithm type and other interfaces
Mirrors changes in nodejs/node#58294
Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>
Co-authored-by: Filip Skokan <panva.ip@gmail.com>
* Update src/utils/parser/constants.mjs
Co-authored-by: Filip Skokan <panva.ip@gmail.com>
---------
Co-authored-by: Filip Skokan <panva.ip@gmail.com>
targos pushed a commit that referenced this pull request May 16, 2025
@panva@targos
doc: fix CryptoKey.algorithm type and other interfaces in webcrypto.md
2bb433d
PR-URL: #58294
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
@github-actionsgithub-actionsBot mentioned this pull request May 20, 2025
Merged
aduh95 pushed a commit that referenced this pull request Jun 10, 2025
@panva@aduh95
doc: fix CryptoKey.algorithm type and other interfaces in webcrypto.md
b22bb03
PR-URL: #58294
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
@github-actionsgithub-actionsBot mentioned this pull request Jun 10, 2025
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jasnelljasnelljasnell approved these changes
@lpincalpincalpinca approved these changes
@anonriganonriganonrig approved these changes
@ovflowdovflowdovflowd approved these changes
+1 more reviewer
@flakey5flakey5flakey5 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.commit-queue-squashAdd this label to instruct the Commit Queue to squash all the PR commits into the first one.cryptoIssues and PRs related to the crypto subsystem.docIssues and PRs related to the documentations.toolsIssues and PRs related to the tools directory.webcrypto

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@panva@nodejs-github-bot@jasnell@lpinca@anonrig@ovflowd@flakey5