mdn / content

The content behind MDN Web Docs
https://developer.mozilla.org
Other
9.13k stars 22.45k forks source link

RsaHashedKeyGenParams.hash property type #21908

Open guillaume-fr opened 1 year ago

guillaume-fr commented 1 year ago

MDN URL

https://developer.mozilla.org/en-US/docs/Web/API/RsaHashedKeyGenParams

What specific section or headline is this issue about?

No response

What information was incorrect, unhelpful, or incomplete?

Doc says hash property is a string. Testing it with Chrome on a freshly imported CryptoKey, this property contains an object with a name property, that hash.name property is a string. It might be confusion between the interface used to generate key and the one available in CryptoKey objet, it might also be the spec being flexible (?). Current documentation is misleading.

What did you expect to see?

Description of hash property being an object with a string-typed name property

Do you have any supporting links, references, or citations?

https://w3c.github.io/webcrypto/#dfn-RsaHashedKeyGenParams

Do you have anything more you want to share?

No response

MDN metadata

Page report details * Folder: `en-us/web/api/rsahashedkeygenparams` * MDN URL: https://developer.mozilla.org/en-US/docs/Web/API/RsaHashedKeyGenParams * GitHub URL: https://github.com/mdn/content/blob/main/files/en-us/web/api/rsahashedkeygenparams/index.md * Last commit: https://github.com/mdn/content/commit/06105598d11001e9f12d80ad05087f1df3c0634b * Document last modified: 2022-10-10T09:00:13.000Z
Josh-Cena commented 3 months ago

For anyone working on this: you can pass a string as hash when using it as a parameter for generateKey, but the property that's on CryptoKey.algorithm will be an object.