authダウンロード - authソースコードのダウンロード

auth

その他のカテゴリー

v3.1.7

ダウンロード

認証

Nuxt用の代替AUTHモジュール

情報

このモジュールは、 @nuxtjs/authに代わるものとして意図されていますが、これは逆方向の互換性サポートのないNuxt3のみです。

設定

@nuxt-alt/authと@nuxt-alt/http依存関係をプロジェクトに追加します

yarn add @nuxt-alt/auth @nuxt-alt/http

@nuxt-alt/authと@pinia/nuxtをnuxt.config.tsのmodulesセクションに追加

注： @nuxt-alt/httpを指定する必要はありません。自動的に追加されますが、手動で追加する場合は、Authモジュールの下（および使用している場合はプロキシモジュールより上）にあることを確認してください。また、PINIAは必要ありません。デフォルトでNuxtのuseStateを使用します。

 export default defineNuxtConfig ( {
    modules : [
        '@nuxt-alt/auth'
    ] ,
    auth : {
        /* module options */
    }
} ) ;

ドキュメント

ドキュメントを読んでください

変更

モジュールは、「@nuxt-alt/http」を機能させるために「@nuxt-alt/http」を使用し、そのモジュールはohmyfetchを拡張します。 dataを使用してデータを投稿している場合は、これがohmyfetch使用するものであるため、 body使用する必要があることに注意してください。 SSRを使用する場合は、 @nuxt-alt/proxyモジュールの使用を検討してください。

合成可能

useAuth() composableは、AUTHメソッドにアクセスするために使用できるようになりました。

オプション

ほとんどのオプションは、 @nuxtjs/authモジュールから直接取得されます。さらに、いくつかの追加のオプションがあります。

`globalMiddleware`

タイプ： Boolean
デフォルト： false

ミドルウェアをグローバルに使用できる/無効にします。

`enableMiddleware`

タイプ： Boolean
デフォルト： true

組み込みのミドルウェアを有効/無効にします。

`stores.state.namespace`

タイプ： String
デフォルト： auth

これは、nuxt usestateに使用する名前空間です。

`stores.pinia.enabled`

タイプ： Boolean
デフォルト： false

このオプションを有効にしてPiniaストアを使用し、Bey Defaultこれは無効になり、NuxtのuseStateが代わりに使用されます。

`stores.pinia.namespace`

タイプ： String
デフォルト： auth

これは、Piniaストアに使用する名前空間です。

`stores.local.enabled`

タイプ： Boolean
デフォルト： true

このオプションを有効にして、LocalStorageストアを使用します。

`stores.local.prefix`

タイプ： String
デフォルト： auth.

これにより、LocalStorageのプレフィックスが設定されます。

`stores.session.enabled`

タイプ： Boolean
デフォルト： true

このオプションを有効にして、SessionStorageストアを使用します。

`stores.session.prefix`

タイプ： String
デフォルト： auth.

LocalStorageオプションと同様に、これはセッションストレージのプレフィックスです。

`stores.cookie.enabled`

タイプ： Boolean
デフォルト： true

このオプションを有効にして、Cookieストレージを使用します。

`stores.cookie.prefix`

タイプ： String
デフォルト： auth.

LocalStorageオプションと同様に、これはCookieストレージのプレフィックスです。

`stores.cookie.options`

タイプ： Object
デフォルト： { path: '/' }

デフォルトのCookieストレージオプション。

`redirectStrategy`

タイプ： query | storage
デフォルト： storage

使用するリダイレクト戦略のタイプ、リダイレクトstorageためのLocalStorageを利用して、ルートクエリパラメーターを使用したquery使用します。

`tokenValidationInterval`

タイプ： Boolean | Number
デフォルト： false

これは実験的です。 Trueに設定されている場合、デフォルト間隔は1000msで、それ以外の場合はミリ秒で時間を設定します。これは、有効期限のためにトークンを検証しようとするモジュールの頻度です。

`resetOnResponseError`

タイプ： Boolean | Function
デフォルト： false

有効にすると、応答のいずれかに401エラーが発生するとリセットされます。あなたはこれを自分で処理するための関数に変えることができます：

auth: {
    //... module options
    resetOnResponseError : ( error , auth , scheme ) => {
       if ( error . response . status === 401 ) {
           scheme . reset ?. ( )
           auth . redirect ( 'login' )
       }
   } ,
}

TypeScript（2.6.0+）

ユーザー情報は、TypeScriptのように編集できます。

 declare module '@nuxt-alt/auth' {
    interface UserInfo {
        email : string
        name : string
    }
}

トークン（タイプ）

認証トークンに加えて。

デフォルトでは、 $auth.strategy getterは、 tokenまたはrefreshTokenプロパティタイプがないSchemeタイプを使用します。これを支援するために、 $auth.refreshStrategyと$auth.tokenStrategy getterがタイピング用に追加されました。それらはすべて同じことをします、これは単にタイプのヒントを目的としています。