docs: update compact setKeyManagementParameters

panva · panva · commit 2f44381b6b0e · 2025-07-07T23:58:20.000+02:00
diff --git a/docs/jwe/compact/encrypt/classes/CompactEncrypt.md b/docs/jwe/compact/encrypt/classes/CompactEncrypt.md
@@ -112,9 +112,10 @@ You should not use this method. It is only really intended for test and vector
 
 ▸ **setKeyManagementParameters**(`parameters`): `this`
 
-Sets the JWE Key Management parameters to be used when encrypting the Content Encryption Key.
-You do not need to invoke this method, it is only really intended for test and vector
-validation purposes.
+Sets the JWE Key Management parameters to be used when encrypting. Use of this is method is
+really only needed for ECDH based algorithms when utilizing the Agreement PartyUInfo or
+Agreement PartyVInfo parameters. Other parameters will always be randomly generated when needed
+and missing.
 
 #### Parameters
 
diff --git a/src/jwe/compact/encrypt.ts b/src/jwe/compact/encrypt.ts
@@ -76,9 +76,10 @@ export class CompactEncrypt {
   }
 
   /**
-   * Sets the JWE Key Management parameters to be used when encrypting the Content Encryption Key.
-   * You do not need to invoke this method, it is only really intended for test and vector
-   * validation purposes.
+   * Sets the JWE Key Management parameters to be used when encrypting. Use of this is method is
+   * really only needed for ECDH based algorithms when utilizing the Agreement PartyUInfo or
+   * Agreement PartyVInfo parameters. Other parameters will always be randomly generated when needed
+   * and missing.
    *
    * @param parameters JWE Key Management parameters.
    */

Original file line number	Diff line number	Diff line change
`@@ -76,9 +76,10 @@ export class CompactEncrypt {`
`76`	`76`	`}`
`77`	`77`
`78`	`78`	`/**`
`79`		`- * Sets the JWE Key Management parameters to be used when encrypting the Content Encryption Key.`
`80`		`- * You do not need to invoke this method, it is only really intended for test and vector`
`81`		`- * validation purposes.`
	`79`	`+ * Sets the JWE Key Management parameters to be used when encrypting. Use of this is method is`
	`80`	`+ * really only needed for ECDH based algorithms when utilizing the Agreement PartyUInfo or`
	`81`	`+ * Agreement PartyVInfo parameters. Other parameters will always be randomly generated when needed`
	`82`	`+ * and missing.`
`82`	`83`	`*`
`83`	`84`	`* @param parameters JWE Key Management parameters.`
`84`	`85`	`*/`