From 7cb8af45eb1cbb420aadba59c8a009f8cf2db571 Mon Sep 17 00:00:00 2001 From: Filip Skokan Date: Sat, 22 Jan 2022 11:01:12 +0100 Subject: [PATCH] docs: update RemoteJWKSetOptions durations with the unit closes #347 --- docs/interfaces/jwks_remote.RemoteJWKSetOptions.md | 4 ++-- src/jwks/remote.ts | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/interfaces/jwks_remote.RemoteJWKSetOptions.md b/docs/interfaces/jwks_remote.RemoteJWKSetOptions.md index ba00b753..57f55508 100644 --- a/docs/interfaces/jwks_remote.RemoteJWKSetOptions.md +++ b/docs/interfaces/jwks_remote.RemoteJWKSetOptions.md @@ -30,7 +30,7 @@ ___ • `Optional` **cooldownDuration**: `number` -Duration for which no more HTTP requests will be triggered +Duration (in milliseconds) for which no more HTTP requests will be triggered after a previous successful fetch. Default is 30000. ___ @@ -39,5 +39,5 @@ ___ • `Optional` **timeoutDuration**: `number` -Timeout for the HTTP request. When reached the request will be +Timeout (in milliseconds) for the HTTP request. When reached the request will be aborted and the verification will fail. Default is 5000. diff --git a/src/jwks/remote.ts b/src/jwks/remote.ts index 4f3c2035..f26bd087 100644 --- a/src/jwks/remote.ts +++ b/src/jwks/remote.ts @@ -39,13 +39,13 @@ interface Cache { */ export interface RemoteJWKSetOptions { /** - * Timeout for the HTTP request. When reached the request will be + * Timeout (in milliseconds) for the HTTP request. When reached the request will be * aborted and the verification will fail. Default is 5000. */ timeoutDuration?: number /** - * Duration for which no more HTTP requests will be triggered + * Duration (in milliseconds) for which no more HTTP requests will be triggered * after a previous successful fetch. Default is 30000. */ cooldownDuration?: number