docs: add more symbol document, ignore ts-private fields

Author: panva

docs/jwe/compact/encrypt/classes/CompactEncrypt.md

@@ -27,6 +27,8 @@ console.log(jwe)
 
 ▸ **new CompactEncrypt**(`plaintext`): [`CompactEncrypt`](CompactEncrypt.md)
 
+[CompactEncrypt](CompactEncrypt.md) constructor
+
 #### Parameters
 
 | Parameter | Type | Description |

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

@@ -28,6 +28,8 @@ console.log(jwe)
 
 ▸ **new FlattenedEncrypt**(`plaintext`): [`FlattenedEncrypt`](FlattenedEncrypt.md)
 
+[FlattenedEncrypt](FlattenedEncrypt.md) constructor
+
 #### Parameters
 
 | Parameter | Type | Description |

docs/jwe/general/encrypt/classes/GeneralEncrypt.md

@@ -31,6 +31,8 @@ console.log(jwe)
 
 ▸ **new GeneralEncrypt**(`plaintext`): [`GeneralEncrypt`](GeneralEncrypt.md)
 
+[GeneralEncrypt](GeneralEncrypt.md) constructor
+
 #### Parameters
 
 | Parameter | Type | Description |

docs/jwks/remote/interfaces/ExportedJWKSCache.md

@@ -12,8 +12,12 @@ See [jwksCache](../variables/jwksCache.md).
 
 • **jwks**: [`JSONWebKeySet`](../../../types/interfaces/JSONWebKeySet.md)
 
+Current cached JSON Web Key Set
+
 ***
 
 ### uat
 
 • **uat**: `number`
+
+Last updated at timestamp (seconds since epoch)

docs/jwks/remote/type-aliases/FetchImplementation.md

@@ -10,14 +10,14 @@ See [customFetch](../variables/customFetch.md).
 
 ## Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `url` | `string` |
-| `options` | \{`headers`: [`Headers`](https://developer.mozilla.org/docs/Web/API/Headers);`method`: `"GET"`;`redirect`: `"manual"`;`signal`: [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal); \} |
-| `options.headers` | [`Headers`](https://developer.mozilla.org/docs/Web/API/Headers) |
-| `options.method` | `"GET"` |
-| `options.redirect` | `"manual"` |
-| `options.signal` | [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal) |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `url` | `string` | - |
+| `options` | \{`headers`: [`Headers`](https://developer.mozilla.org/docs/Web/API/Headers);`method`: `"GET"`;`redirect`: `"manual"`;`signal`: [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal); \} | - |
+| `options.headers` | [`Headers`](https://developer.mozilla.org/docs/Web/API/Headers) | HTTP Headers |
+| `options.method` | `"GET"` | The [request method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods) |
+| `options.redirect` | `"manual"` | See [Request.redirect](https://developer.mozilla.org/docs/Web/API/Request/redirect) |
+| `options.signal` | [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal) | - |
 
 ## Returns
 

docs/jws/compact/sign/classes/CompactSign.md

@@ -27,6 +27,8 @@ console.log(jws)
 
 ▸ **new CompactSign**(`payload`): [`CompactSign`](CompactSign.md)
 
+[CompactSign](CompactSign.md) constructor
+
 #### Parameters
 
 | Parameter | Type | Description |

docs/jws/flattened/sign/classes/FlattenedSign.md

@@ -27,6 +27,8 @@ console.log(jws)
 
 ▸ **new FlattenedSign**(`payload`): [`FlattenedSign`](FlattenedSign.md)
 
+[FlattenedSign](FlattenedSign.md) constructor
+
 #### Parameters
 
 | Parameter | Type | Description |

docs/jws/general/sign/classes/GeneralSign.md

@@ -30,6 +30,8 @@ console.log(jws)
 
 ▸ **new GeneralSign**(`payload`): [`GeneralSign`](GeneralSign.md)
 
+[GeneralSign](GeneralSign.md) constructor
+
 #### Parameters
 
 | Parameter | Type | Description |

docs/jwt/encrypt/classes/EncryptJWT.md

@@ -30,6 +30,8 @@ console.log(jwt)
 
 ▸ **new EncryptJWT**(`payload`): [`EncryptJWT`](EncryptJWT.md)
 
+[EncryptJWT](EncryptJWT.md) constructor
+
 #### Parameters
 
 | Parameter | Type | Description |

docs/jwt/produce/classes/ProduceJWT.md

@@ -12,6 +12,8 @@ Generic class for JWT producing.
 
 ▸ **new ProduceJWT**(`payload`): [`ProduceJWT`](ProduceJWT.md)
 
+[ProduceJWT](ProduceJWT.md) constructor
+
 #### Parameters
 
 | Parameter | Type | Description |

docs/jwt/sign/classes/SignJWT.md

@@ -109,6 +109,8 @@ console.log(jwt)
 
 ▸ **new SignJWT**(`payload`): [`SignJWT`](SignJWT.md)
 
+[SignJWT](SignJWT.md) constructor
+
 #### Parameters
 
 | Parameter | Type | Description |

docs/jwt/unsecured/classes/UnsecuredJWT.md

@@ -41,6 +41,8 @@ console.log(payload)
 
 ▸ **new UnsecuredJWT**(`payload`): [`UnsecuredJWT`](UnsecuredJWT.md)
 
+[UnsecuredJWT](UnsecuredJWT.md) constructor
+
 #### Parameters
 
 | Parameter | Type | Description |

docs/util/errors/classes/JOSEAlgNotAllowed.md

@@ -30,4 +30,4 @@ if (err instanceof jose.errors.JOSEAlgNotAllowed) {
 
 • **code**: `string` = `'ERR_JOSE_ALG_NOT_ALLOWED'`
 
-A unique error code for this particular error subclass.
+A unique error code for [JOSEAlgNotAllowed](JOSEAlgNotAllowed.md).

docs/util/errors/classes/JOSEError.md

@@ -22,4 +22,4 @@ if (err instanceof jose.errors.JOSEError) {
 
 • **code**: `string` = `'ERR_JOSE_GENERIC'`
 
-A unique error code for this particular error subclass.
+A unique error code for [JOSEError](JOSEError.md).

docs/util/errors/classes/JOSENotSupported.md

@@ -31,4 +31,4 @@ if (err instanceof jose.errors.JOSENotSupported) {
 
 • **code**: `string` = `'ERR_JOSE_NOT_SUPPORTED'`
 
-A unique error code for this particular error subclass.
+A unique error code for [JOSENotSupported](JOSENotSupported.md).

docs/util/errors/classes/JWEDecryptionFailed.md

@@ -30,4 +30,4 @@ if (err instanceof jose.errors.JWEDecryptionFailed) {
 
 • **code**: `string` = `'ERR_JWE_DECRYPTION_FAILED'`
 
-A unique error code for this particular error subclass.
+A unique error code for [JWEDecryptionFailed](JWEDecryptionFailed.md).

docs/util/errors/classes/JWEInvalid.md

@@ -30,4 +30,4 @@ if (err instanceof jose.errors.JWEInvalid) {
 
 • **code**: `string` = `'ERR_JWE_INVALID'`
 
-A unique error code for this particular error subclass.
+A unique error code for [JWEInvalid](JWEInvalid.md).

docs/util/errors/classes/JWKInvalid.md

@@ -30,4 +30,4 @@ if (err instanceof jose.errors.JWKInvalid) {
 
 • **code**: `string` = `'ERR_JWK_INVALID'`
 
-A unique error code for this particular error subclass.
+A unique error code for [JWKInvalid](JWKInvalid.md).

docs/util/errors/classes/JWKSInvalid.md

@@ -30,4 +30,4 @@ if (err instanceof jose.errors.JWKSInvalid) {
 
 • **code**: `string` = `'ERR_JWKS_INVALID'`
 
-A unique error code for this particular error subclass.
+A unique error code for [JWKSInvalid](JWKSInvalid.md).

docs/util/errors/classes/JWKSMultipleMatchingKeys.md

@@ -30,4 +30,4 @@ if (err instanceof jose.errors.JWKSMultipleMatchingKeys) {
 
 • **code**: `string` = `'ERR_JWKS_MULTIPLE_MATCHING_KEYS'`
 
-A unique error code for this particular error subclass.
+A unique error code for [JWKSMultipleMatchingKeys](JWKSMultipleMatchingKeys.md).

docs/util/errors/classes/JWKSNoMatchingKey.md

@@ -30,4 +30,4 @@ if (err instanceof jose.errors.JWKSNoMatchingKey) {
 
 • **code**: `string` = `'ERR_JWKS_NO_MATCHING_KEY'`
 
-A unique error code for this particular error subclass.
+A unique error code for [JWKSNoMatchingKey](JWKSNoMatchingKey.md).

docs/util/errors/classes/JWKSTimeout.md

@@ -30,4 +30,4 @@ if (err instanceof jose.errors.JWKSTimeout) {
 
 • **code**: `string` = `'ERR_JWKS_TIMEOUT'`
 
-A unique error code for this particular error subclass.
+A unique error code for [JWKSTimeout](JWKSTimeout.md).

docs/util/errors/classes/JWSInvalid.md

@@ -30,4 +30,4 @@ if (err instanceof jose.errors.JWSInvalid) {
 
 • **code**: `string` = `'ERR_JWS_INVALID'`
 
-A unique error code for this particular error subclass.
+A unique error code for [JWSInvalid](JWSInvalid.md).

docs/util/errors/classes/JWSSignatureVerificationFailed.md

@@ -30,4 +30,4 @@ if (err instanceof jose.errors.JWSSignatureVerificationFailed) {
 
 • **code**: `string` = `'ERR_JWS_SIGNATURE_VERIFICATION_FAILED'`
 
-A unique error code for this particular error subclass.
+A unique error code for [JWSSignatureVerificationFailed](JWSSignatureVerificationFailed.md).

docs/util/errors/classes/JWTClaimValidationFailed.md

@@ -38,7 +38,7 @@ The Claim for which the validation failed.
 
 • **code**: `string` = `'ERR_JWT_CLAIM_VALIDATION_FAILED'`
 
-A unique error code for this particular error subclass.
+A unique error code for [JWTClaimValidationFailed](JWTClaimValidationFailed.md).
 
 ***
 

docs/util/errors/classes/JWTExpired.md

@@ -42,7 +42,7 @@ The Claim for which the validation failed.
 
 • **code**: `string` = `'ERR_JWT_EXPIRED'`
 
-A unique error code for this particular error subclass.
+A unique error code for [JWTExpired](JWTExpired.md).
 
 ***
 

docs/util/errors/classes/JWTInvalid.md

@@ -30,4 +30,4 @@ if (err instanceof jose.errors.JWTInvalid) {
 
 • **code**: `string` = `'ERR_JWT_INVALID'`
 
-A unique error code for this particular error subclass.
+A unique error code for [JWTInvalid](JWTInvalid.md).

src/jwe/compact/encrypt.ts

@@ -26,9 +26,14 @@ import { FlattenedEncrypt } from '../flattened/encrypt.js'
  * ```
  */
 export class CompactEncrypt {
+  /** @ignore */
   private _flattened: FlattenedEncrypt
 
-  /** @param plaintext Binary representation of the plaintext to encrypt. */
+  /**
+   * {@link CompactEncrypt} constructor
+   *
+   * @param plaintext Binary representation of the plaintext to encrypt.
+   */
   constructor(plaintext: Uint8Array) {
     this._flattened = new FlattenedEncrypt(plaintext)
   }

src/jwe/flattened/encrypt.ts

@@ -36,23 +36,35 @@ import checkKeyType from '../../lib/check_key_type.js'
  * ```
  */
 export class FlattenedEncrypt {
+  /** @ignore */
   private _plaintext: Uint8Array
 
+  /** @ignore */
   private _protectedHeader!: types.JWEHeaderParameters | undefined
 
+  /** @ignore */
   private _sharedUnprotectedHeader!: types.JWEHeaderParameters | undefined
 
+  /** @ignore */
   private _unprotectedHeader!: types.JWEHeaderParameters | undefined
 
+  /** @ignore */
   private _aad!: Uint8Array | undefined
 
+  /** @ignore */
   private _cek!: Uint8Array | undefined
 
+  /** @ignore */
   private _iv!: Uint8Array | undefined
 
+  /** @ignore */
   private _keyManagementParameters!: types.JWEKeyManagementHeaderParameters
 
-  /** @param plaintext Binary representation of the plaintext to encrypt. */
+  /**
+   * {@link FlattenedEncrypt} constructor
+   *
+   * @param plaintext Binary representation of the plaintext to encrypt.
+   */
   constructor(plaintext: Uint8Array) {
     if (!(plaintext instanceof Uint8Array)) {
       throw new TypeError('plaintext must be an instance of Uint8Array')

src/jwe/general/encrypt.ts

@@ -95,17 +95,26 @@ class IndividualRecipient implements Recipient {
  * ```
  */
 export class GeneralEncrypt {
+  /** @ignore */
   private _plaintext: Uint8Array
 
+  /** @ignore */
   private _recipients: IndividualRecipient[] = []
 
+  /** @ignore */
   private _protectedHeader!: types.JWEHeaderParameters
 
+  /** @ignore */
   private _unprotectedHeader!: types.JWEHeaderParameters
 
+  /** @ignore */
   private _aad!: Uint8Array
 
-  /** @param plaintext Binary representation of the plaintext to encrypt. */
+  /**
+   * {@link GeneralEncrypt} constructor
+   *
+   * @param plaintext Binary representation of the plaintext to encrypt.
+   */
   constructor(plaintext: Uint8Array) {
     this._plaintext = plaintext
   }

src/jwks/local.ts

@@ -56,8 +56,10 @@ function clone<T>(obj: T): T {
 }
 
 class LocalJWKSet {
+  /** @ignore */
   private _jwks?: types.JSONWebKeySet
 
+  /** @ignore */
   private _cached: WeakMap<types.JWK, Cache> = new WeakMap()
 
   constructor(jwks: unknown) {

src/jwks/remote.ts

@@ -146,10 +146,15 @@ export const customFetch: unique symbol = Symbol()
 
 /** See {@link customFetch}. */
 export type FetchImplementation = (
+  /** URL the request is being made sent to {@link !fetch} as the `resource` argument */
   url: string,
+  /** Options otherwise sent to {@link !fetch} as the `options` argument */
   options: {
+    /** HTTP Headers */
     headers: Headers
+    /** The {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods request method} */
     method: 'GET'
+    /** See {@link !Request.redirect} */
     redirect: 'manual'
     signal: AbortSignal
   },
@@ -272,7 +277,13 @@ export interface RemoteJWKSetOptions {
 
 /** See {@link jwksCache}. */
 export interface ExportedJWKSCache {
+  /**
+   * Current cached JSON Web Key Set
+   */
   jwks: types.JSONWebKeySet
+  /**
+   * Last updated at timestamp (seconds since epoch)
+   */
   uat: number
 }
 
@@ -301,24 +312,33 @@ function isFreshJwksCache(input: unknown, cacheMaxAge: number): input is Exporte
 }
 
 class RemoteJWKSet {
+  /** @ignore */
   private _url: URL
 
+  /** @ignore */
   private _timeoutDuration: number
 
+  /** @ignore */
   private _cooldownDuration: number
 
+  /** @ignore */
   private _cacheMaxAge: number
 
+  /** @ignore */
   private _jwksTimestamp?: number
 
+  /** @ignore */
   private _pendingFetch?: Promise<unknown>
 
+  /** @ignore */
   private _headers: Headers
 
   private [customFetch]?: FetchImplementation
 
+  /** @ignore */
   private _local!: ReturnType<typeof createLocalJWKSet>
 
+  /** @ignore */
   private _cache?: JWKSCacheInput
 
   constructor(url: unknown, options?: RemoteJWKSetOptions) {

src/jws/compact/sign.ts

@@ -26,9 +26,14 @@ import { FlattenedSign } from '../flattened/sign.js'
  * ```
  */
 export class CompactSign {
+  /** @ignore */
   private _flattened: FlattenedSign
 
-  /** @param payload Binary representation of the payload to sign. */
+  /**
+   * {@link CompactSign} constructor
+   *
+   * @param payload Binary representation of the payload to sign.
+   */
   constructor(payload: Uint8Array) {
     this._flattened = new FlattenedSign(payload)
   }