fix: deprecated unused clockSkewInSeconds and userInfoJwtIssuer settings

ncats · Jun 2, 2022 · 52e8799 · 52e8799
1 parent 8527161
commit 52e8799
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/docs/oidc-client-ts.api.md b/docs/oidc-client-ts.api.md
@@ -325,6 +325,7 @@ export interface OidcClientSettings {
     client_id: string;
     // (undocumented)
     client_secret?: string;
+    // @deprecated (undocumented)
     clockSkewInSeconds?: number;
     display?: string;
     extraQueryParams?: Record<string, string | number | boolean>;
@@ -349,7 +350,7 @@ export interface OidcClientSettings {
     staleStateAgeInSeconds?: number;
     stateStore?: StateStore;
     ui_locales?: string;
-    // (undocumented)
+    // @deprecated (undocumented)
     userInfoJwtIssuer?: "ANY" | "OP" | string;
 }
 

diff --git a/src/OidcClientSettings.ts b/src/OidcClientSettings.ts
@@ -77,8 +77,10 @@ export interface OidcClientSettings {
     loadUserInfo?: boolean;
     /** Number (in seconds) indicating the age of state entries in storage for authorize requests that are considered abandoned and thus can be cleaned up (default: 300) */
     staleStateAgeInSeconds?: number;
-    /** The window of time (in seconds) to allow the current time to deviate when validating token's iat, nbf, and exp values (default: 300) */
+
+    /** @deprecated Unused */
     clockSkewInSeconds?: number;
+    /** @deprecated Unused */
     userInfoJwtIssuer?: "ANY" | "OP" | string;
 
     /**