docs: update JWK docs

panva · Sep 13, 2024 · 092dadf · 092dadf
1 parent 746c727
commit 092dadf
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git a/docs/interfaces/types.JWK.md b/docs/interfaces/types.JWK.md
@@ -9,6 +9,16 @@ Support from the community to continue maintaining and improving this module is
 JSON Web Key ([JWK](https://www.rfc-editor.org/rfc/rfc7517)). "RSA", "EC", "OKP", and "oct"
 key types are supported.
 
+**`See`**
+
+ - [JWK_OKP_Public](types.JWK_OKP_Public.md)
+ - [JWK_OKP_Private](types.JWK_OKP_Private.md)
+ - [JWK_EC_Public](types.JWK_EC_Public.md)
+ - [JWK_EC_Private](types.JWK_EC_Private.md)
+ - [JWK_RSA_Public](types.JWK_RSA_Public.md)
+ - [JWK_RSA_Private](types.JWK_RSA_Private.md)
+ - [JWK_oct](types.JWK_oct.md)
+
 ## Table of contents
 
 ### Properties

diff --git a/src/types.d.ts b/src/types.d.ts
@@ -183,9 +183,7 @@ export interface JWK_RSA_Private extends JWK_RSA_Public, JWKParameters {
   qi: string
 }
 
-/**
- * Convenience interface for oct JSON Web Keys
- */
+/** Convenience interface for oct JSON Web Keys */
 export interface JWK_oct extends JWKParameters {
   /** Key Value */
   k: string
@@ -194,6 +192,14 @@ export interface JWK_oct extends JWKParameters {
 /**
  * JSON Web Key ({@link https://www.rfc-editor.org/rfc/rfc7517 JWK}). "RSA", "EC", "OKP", and "oct"
  * key types are supported.
+ *
+ * @see {@link JWK_OKP_Public}
+ * @see {@link JWK_OKP_Private}
+ * @see {@link JWK_EC_Public}
+ * @see {@link JWK_EC_Private}
+ * @see {@link JWK_RSA_Public}
+ * @see {@link JWK_RSA_Private}
+ * @see {@link JWK_oct}
  */
 export interface JWK extends JWKParameters {
   /**