Skip to content

Commit 3b8ff71

Browse files
committed
docs: add various exported symbol descriptions
1 parent fc4e7da commit 3b8ff71

File tree

7 files changed

+15
-0
lines changed

7 files changed

+15
-0
lines changed

docs/jwks/remote/interfaces/ExportedJWKSCache.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
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).
66

7+
See [jwksCache](../variables/jwksCache.md).
8+
79
## Properties
810

911
### jwks

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Support from the community to continue maintaining and improving this module is
66

77
**FetchImplementation**: (`url`, `options`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Response`](https://developer.mozilla.org/docs/Web/API/Response)\>
88

9+
See [customFetch](../variables/customFetch.md).
10+
911
## Parameters
1012

1113
| Parameter | Type |

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@
55
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).
66

77
**JWKSCacheInput**: [`ExportedJWKSCache`](../interfaces/ExportedJWKSCache.md) \| [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `never`\>
8+
9+
See [jwksCache](../variables/jwksCache.md).

docs/types/interfaces/JWTDecryptResult.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
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).
66

7+
Encrypted JSON Web Token (JWT) decryption result
8+
79
## Type Parameters
810

911
| Type Parameter | Default type |

docs/types/interfaces/JWTVerifyResult.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
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).
66

7+
Signed JSON Web Token (JWT) verification result
8+
79
## Type Parameters
810

911
| Type Parameter | Default type |

src/jwks/remote.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,7 @@ if (typeof navigator === 'undefined' || !navigator.userAgent?.startsWith?.('Mozi
144144
*/
145145
export const customFetch: unique symbol = Symbol()
146146

147+
/** See {@link customFetch}. */
147148
export type FetchImplementation = (
148149
url: string,
149150
options: {
@@ -271,11 +272,13 @@ export interface RemoteJWKSetOptions {
271272
[customFetch]?: FetchImplementation
272273
}
273274

275+
/** See {@link jwksCache}. */
274276
export interface ExportedJWKSCache {
275277
jwks: types.JSONWebKeySet
276278
uat: number
277279
}
278280

281+
/** See {@link jwksCache}. */
279282
export type JWKSCacheInput = ExportedJWKSCache | Record<string, never>
280283

281284
function isFreshJwksCache(input: unknown, cacheMaxAge: number): input is ExportedJWKSCache {

src/types.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -639,6 +639,7 @@ export interface CompactVerifyResult {
639639
protectedHeader: CompactJWSHeaderParameters
640640
}
641641

642+
/** Signed JSON Web Token (JWT) verification result */
642643
export interface JWTVerifyResult<PayloadType = JWTPayload> {
643644
/** JWT Claims Set. */
644645
payload: PayloadType & JWTPayload
@@ -647,6 +648,7 @@ export interface JWTVerifyResult<PayloadType = JWTPayload> {
647648
protectedHeader: JWTHeaderParameters
648649
}
649650

651+
/** Encrypted JSON Web Token (JWT) decryption result */
650652
export interface JWTDecryptResult<PayloadType = JWTPayload> {
651653
/** JWT Claims Set. */
652654
payload: PayloadType & JWTPayload

0 commit comments

Comments
 (0)