Skip to content

Commit

Permalink
doc: consistent webcrypto node.keyObject format
Browse files Browse the repository at this point in the history
PR-URL: #37200
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
  • Loading branch information
panva committed Feb 5, 2021
1 parent 88be944 commit 931c2d1
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/api/webcrypto.md
Original file line number Diff line number Diff line change
Expand Up @@ -608,10 +608,10 @@ added: v15.0.0
-->

* `format`: {string} Must be one of `'raw'`, `'pkcs8'`, `'spki'`, `'jwk'`, or
`node.keyObject`.
`'node.keyObject'`.
* `key`: {CryptoKey}
* Returns: {Promise} containing {ArrayBuffer}, or, if `format` is
`node.keyObject`, a {KeyObject}.
`'node.keyObject'`, a {KeyObject}.

Exports the given key into the specified format, if supported.

Expand Down Expand Up @@ -695,7 +695,7 @@ added: v15.0.0
-->

* `format`: {string} Must be one of `'raw'`, `'pkcs8'`, `'spki'`, `'jwk'`, or
`node.keyObject`.
`'node.keyObject'`.
* `keyData`: {ArrayBuffer|TypedArray|DataView|Buffer|KeyObject}
<!--lint disable maximum-line-length remark-lint-->
* `algorithm`: {RsaHashedImportParams|EcKeyImportParams|HmacImportParams|AesImportParams|Pbkdf2ImportParams|NodeDsaImportParams|NodeDhImportParams|NodeScryptImportParams|NodeEdKeyImportParams}
Expand Down Expand Up @@ -1465,7 +1465,7 @@ added: v15.0.0

The Node.js Web Crypto API extends various aspects of the Web Crypto API.
These extensions are consistently identified by prepending names with the
`node.` prefix. For instance, the `node.keyObject` key format can be
`node.` prefix. For instance, the `'node.keyObject'` key format can be
used with the `subtle.exportKey()` and `subtle.importKey()` methods to
convert between a WebCrypto {CryptoKey} object and a Node.js {KeyObject}.

Expand Down

0 comments on commit 931c2d1

Please sign in to comment.