🔄 synced local 'content/2.nuxt-auth/' with remote 'docs/content/' (#185)

Co-authored-by: sideborg <null>

Author: sideborg

content/2.nuxt-auth/2.configuration/2.nuxt-config.md

@@ -66,14 +66,14 @@ interface ModuleOptions {
   provider?: AuthProviders
   /**
    * Configuration of the application-side session. You can configure the following attributes:
-   * - enableRefreshPeriodically: Whether to refresh the session every `X` milliseconds. Set this to `false` to turn it off. The session will only be refreshed if a session already exists. Setting this to `true` will refresh the session every second. Setting this to `false` will turn off session refresh. Setting this to a number `X` will refresh the session every `X` milliseconds.
-   * - enableRefreshOnWindowFocus: Whether to refresh the session every time the browser window is refocused.
+   * - enablePeriodically: Whether to refresh the session every `X` milliseconds. Set this to `false` to turn it off. The session will only be refreshed if a session already exists. Setting this to `true` will refresh the session every second. Setting this to `false` will turn off session refresh. Setting this to a number `X` will refresh the session every `X` milliseconds.
+   * - enableOnWindowFocus: Whether to refresh the session every time the browser window is refocused.
    *
-   * @example { enableRefreshPeriodically: 5000 }
-   * @example { enableRefreshOnWindowFocus: false }
-   * @default { enableRefreshPeriodically: false, enableRefreshOnWindowFocus: true }
+   * @example { enablePeriodically: 5000 }
+   * @example { enableOnWindowFocus: false }
+   * @default { enablePeriodically: false, enableOnWindowFocus: true }
    */
-  session?: SessionConfig
+  sessionRefresh?: SessionRefreshConfig
   /**
    * Whether to add a global authentication middleware that protects all pages. Can be either `false` to disable, `true` to enabled
    * or an object to enable and apply extended configuration.
@@ -505,11 +505,11 @@ type ProviderRefresh = {
   }
 }
 ```
-```ts [SessionConfig]
+```ts [SessionRefreshConfig]
 /**
  * Configuration for the application-side session.
  */
-type SessionConfig = {
+type SessionRefreshConfig = {
   /**
    * Whether to refresh the session every `X` milliseconds. Set this to `false` to turn it off. The session will only be refreshed if a session already exists.
    *
@@ -521,22 +521,22 @@ type SessionConfig = {
    * @default false
    *
    */
-  enableRefreshPeriodically: number | boolean,
+  enablePeriodically: number | boolean,
   /**
    * Whether to refresh the session every time the browser window is refocused.
    *
    * @example false
    * @default true
    */
-  enableRefreshOnWindowFocus: boolean
+  enableOnWindowFocus: boolean
   /**
    * A custom refresh handler to use. This can be used to implement custom session refresh logic.
    * If not set, the default refresh handler will be used.
    *
    * @example ./src/runtime/utils/refreshHandler.ts
    * @default undefined
    */
-  refreshHandler?: RefreshHandler;
+  handler?: RefreshHandler;
 }
 ```
 ```ts [GlobalMiddlewareOptions]

content/2.nuxt-auth/2.configuration/5.session-config.md

@@ -6,7 +6,7 @@ Use this section to configure the application-side session. The following type d
 /**
  * Configuration for the application-side session.
  */
-type SessionConfig = {
+type SessionRefreshConfig = {
   /**
    * Whether to refresh the session every `X` milliseconds. Set this to `false` to turn it off. The session will only be refreshed if a session already exists.
    *
@@ -18,38 +18,38 @@ type SessionConfig = {
    * @default false
    *
    */
-  enableRefreshPeriodically: number | boolean
+  enablePeriodically: number | boolean
   /**
    * Whether to refresh the session every time the browser window is refocused.
    *
    * @example false
    * @default true
    */
-  enableRefreshOnWindowFocus: boolean
+  enableOnWindowFocus: boolean
   /**
    * A custom refresh handler to use. This can be used to implement custom session refresh logic.
    * If not set, the default refresh handler will be used.
    *
    * @example ./src/runtime/utils/refreshHandler.ts
    * @default undefined
    */
-  refreshHandler?: RefreshHandler;
+  handler?: RefreshHandler;
 }
 ```
 
 ## Application side session
 
-Per default nuxt-auth will use the set values for `enableRefreshPeriodically` & `enableRefreshOnWindowFocus` to refresh your application-side session. If you don't provide a configuration nuxt-auth won't trigger a job that refreshes the session periodically but it will always refresh the session if the window is refocussed.
+Per default nuxt-auth will use the set values for `enablePeriodically` & `enableOnWindowFocus` to refresh your application-side session. If you don't provide a configuration nuxt-auth won't trigger a job that refreshes the session periodically but it will always refresh the session if the window is refocussed.
 
-If you set `enableRefreshPeriodically` simply to true a job will be run every second (1000ms) that will fetch your specified `getSession` endpoint. You can customize the interval if you provide a number instead of a boolean value.
+If you set `enablePeriodically` simply to true a job will be run every second (1000ms) that will fetch your specified `getSession` endpoint. You can customize the interval if you provide a number instead of a boolean value.
 
-To disable the session refresh when the window is refocussed simply set `enableRefreshOnWindowFocus` to `false`.
+To disable the session refresh when the window is refocussed simply set `enableOnWindowFocus` to `false`.
 
 ## Using a custom RefreshHandler
 
 To customize the session refreshing you can provide a refresh handler. A custom `RefreshHandler` requires an `init`- and a `destroy`-function.
 
-`init` will be called when the nuxt application is mounted. Here you may add event listeners and initialize custom refresh behaviour. The method will receive a `RefreshHandlerConfig`. The type consists of `enableRefreshPeriodically` & `enableRefreshOnWindowFocus`.
+`init` will be called when the nuxt application is mounted. Here you may add event listeners and initialize custom refresh behaviour. The method will receive a `RefreshHandlerConfig`. The type consists of `enablePeriodically` & `enableOnWindowFocus`.
 
 `destroy` will be called when your app is unmounted. Here you may run your clean up routine e.g. to remove your event listeners.