Skip to content

Commit 6274d5a

Browse files
committed
docs: mention the apu/apv parameter names in setKeyManagementParameters
1 parent 2f44381 commit 6274d5a

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

docs/jwe/flattened/encrypt/classes/FlattenedEncrypt.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -132,9 +132,9 @@ You should not use this method. It is only really intended for test and vector
132132
**setKeyManagementParameters**(`parameters`): `this`
133133

134134
Sets the JWE Key Management parameters to be used when encrypting. Use of this is method is
135-
really only needed for ECDH based algorithms when utilizing the Agreement PartyUInfo or
136-
Agreement PartyVInfo parameters. Other parameters will always be randomly generated when needed
137-
and missing.
135+
really only needed for ECDH based algorithms when utilizing the "apu" (Agreement PartyUInfo) or
136+
"apv" (Agreement PartyVInfo) parameters. Other parameters will always be randomly generated
137+
when needed and missing.
138138

139139
#### Parameters
140140

docs/jwt/encrypt/classes/EncryptJWT.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -291,9 +291,9 @@ Set the "jti" (JWT ID) Claim.
291291
**setKeyManagementParameters**(`parameters`): `this`
292292

293293
Sets the JWE Key Management parameters to be used when encrypting. Use of this is method is
294-
really only needed for ECDH based algorithms when utilizing the Agreement PartyUInfo or
295-
Agreement PartyVInfo parameters. Other parameters will always be randomly generated when needed
296-
and missing.
294+
really only needed for ECDH based algorithms when utilizing the "apu" (Agreement PartyUInfo) or
295+
"apv" (Agreement PartyVInfo) parameters. Other parameters will always be randomly generated
296+
when needed and missing.
297297

298298
#### Parameters
299299

src/jwe/flattened/encrypt.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,9 @@ export class FlattenedEncrypt {
6666

6767
/**
6868
* Sets the JWE Key Management parameters to be used when encrypting. Use of this is method is
69-
* really only needed for ECDH based algorithms when utilizing the Agreement PartyUInfo or
70-
* Agreement PartyVInfo parameters. Other parameters will always be randomly generated when needed
71-
* and missing.
69+
* really only needed for ECDH based algorithms when utilizing the "apu" (Agreement PartyUInfo) or
70+
* "apv" (Agreement PartyVInfo) parameters. Other parameters will always be randomly generated
71+
* when needed and missing.
7272
*
7373
* @param parameters JWE Key Management parameters.
7474
*/

src/jwt/encrypt.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,9 +106,9 @@ export class EncryptJWT implements types.ProduceJWT {
106106

107107
/**
108108
* Sets the JWE Key Management parameters to be used when encrypting. Use of this is method is
109-
* really only needed for ECDH based algorithms when utilizing the Agreement PartyUInfo or
110-
* Agreement PartyVInfo parameters. Other parameters will always be randomly generated when needed
111-
* and missing.
109+
* really only needed for ECDH based algorithms when utilizing the "apu" (Agreement PartyUInfo) or
110+
* "apv" (Agreement PartyVInfo) parameters. Other parameters will always be randomly generated
111+
* when needed and missing.
112112
*
113113
* @param parameters JWE Key Management parameters.
114114
*/

0 commit comments

Comments
 (0)