From d94469245057e4d8324880642fb2582f177bf46c Mon Sep 17 00:00:00 2001 From: bmhtech07 <64862099+bmhtech07@users.noreply.github.com> Date: Sun, 15 Oct 2023 02:38:18 +0100 Subject: [PATCH] fix: Spelling in code comments and documentation (#547) --- docs/content/v0.6/2.configuration/2.nuxt-config.md | 7 +++++-- src/runtime/types.ts | 6 ++++-- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/content/v0.6/2.configuration/2.nuxt-config.md b/docs/content/v0.6/2.configuration/2.nuxt-config.md index a2bae96e..5fc51943 100644 --- a/docs/content/v0.6/2.configuration/2.nuxt-config.md +++ b/docs/content/v0.6/2.configuration/2.nuxt-config.md @@ -190,20 +190,23 @@ type ProviderLocal = { * Header type to be used in requests. This in combination with `headerName` is used to construct the final authentication-header `nuxt-auth` uses, e.g, for requests via `getSession`. * * @default Bearer - * @exmaple Beer + * @example Beer */ type?: string, /** * Header name to be used in requests that need to be authenticated, e.g., to be used in the `getSession` request. * * @default Authorization - * @exmaple Auth + * @example Auth */ headerName?: string, /** * Maximum age to store the authentication token for. After the expiry time the token is automatically deleted on the application side, i.e., in the users' browser. * * Note: Your backend may reject / expire the token earlier / differently. + * + * @default 1800 + * @example 60 * 60 * 24 */ maxAgeInSeconds?: number, /** diff --git a/src/runtime/types.ts b/src/runtime/types.ts index b4e6e1eb..77e7b036 100644 --- a/src/runtime/types.ts +++ b/src/runtime/types.ts @@ -126,20 +126,22 @@ type ProviderLocal = { * Header type to be used in requests. This in combination with `headerName` is used to construct the final authentication-header `nuxt-auth` uses, e.g, for requests via `getSession`. * * @default Bearer - * @exmaple Beer + * @example Beer */ type?: string, /** * Header name to be used in requests that need to be authenticated, e.g., to be used in the `getSession` request. * * @default Authorization - * @exmaple Auth + * @example Auth */ headerName?: string, /** * Maximum age to store the authentication token for. After the expiry time the token is automatically deleted on the application side, i.e., in the users' browser. * * Note: Your backend may reject / expire the token earlier / differently. + * @default 1800 + * @example 60 * 60 * 24 */ maxAgeInSeconds?: number, /**