docs: add various exported symbol descriptions

panva · panva · commit fc4e7dab4c70 · 2025-02-23T23:18:51.000+01:00
diff --git a/docs/types/interfaces/GeneralDecryptResult.md b/docs/types/interfaces/GeneralDecryptResult.md
@@ -4,7 +4,7 @@
 
 Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by [becoming a sponsor](https://github.com/sponsors/panva).
 
-Flattened JWE JSON Serialization Syntax decryption result
+General JWE JSON Serialization Syntax decryption result
 
 ## Properties
 
diff --git a/docs/types/interfaces/GeneralVerifyResult.md b/docs/types/interfaces/GeneralVerifyResult.md
@@ -4,7 +4,7 @@
 
 Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by [becoming a sponsor](https://github.com/sponsors/panva).
 
-Flattened JWS JSON Serialization Syntax verification result
+General JWS JSON Serialization Syntax verification result
 
 ## Properties
 
diff --git a/src/types.d.ts b/src/types.d.ts
@@ -603,7 +603,7 @@ export interface FlattenedDecryptResult {
   unprotectedHeader?: JWEHeaderParameters
 }
 
-/** Flattened JWE JSON Serialization Syntax decryption result */
+/** General JWE JSON Serialization Syntax decryption result */
 export interface GeneralDecryptResult extends FlattenedDecryptResult {}
 
 /** Compact JWE decryption result */
@@ -627,7 +627,7 @@ export interface FlattenedVerifyResult {
   unprotectedHeader?: JWSHeaderParameters
 }
 
-/** Flattened JWS JSON Serialization Syntax verification result */
+/** General JWS JSON Serialization Syntax verification result */
 export interface GeneralVerifyResult extends FlattenedVerifyResult {}
 
 /** Compact JWS verification result */

Original file line number	Diff line number	Diff line change
`@@ -603,7 +603,7 @@ export interface FlattenedDecryptResult {`
`603`	`603`	`unprotectedHeader?: JWEHeaderParameters`
`604`	`604`	`}`
`605`	`605`
`606`		`-/** Flattened JWE JSON Serialization Syntax decryption result */`
	`606`	`+/** General JWE JSON Serialization Syntax decryption result */`
`607`	`607`	`export interface GeneralDecryptResult extends FlattenedDecryptResult {}`
`608`	`608`
`609`	`609`	`/** Compact JWE decryption result */`
`@@ -627,7 +627,7 @@ export interface FlattenedVerifyResult {`
`627`	`627`	`unprotectedHeader?: JWSHeaderParameters`
`628`	`628`	`}`
`629`	`629`
`630`		`-/** Flattened JWS JSON Serialization Syntax verification result */`
	`630`	`+/** General JWS JSON Serialization Syntax verification result */`
`631`	`631`	`export interface GeneralVerifyResult extends FlattenedVerifyResult {}`
`632`	`632`
`633`	`633`	`/** Compact JWS verification result */`