auth Download - auth Quellcode Download

auth

Andere Kategorien

v3.1.7

Herunterladen

Auth

Alternatives Authodul für Nuxt

Info

Dieses Modul ist als Alternative zu @nuxtjs/auth gemeint, außer dass dies nur für Nuxt3 ist, nur ohne Unterstützung für die Kompatibilität nach hinten.

Aufstellen

Fügen Sie @nuxt-alt/auth und @nuxt-alt/http Abhängigkeit zu Ihrem Projekt hinzu

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

Fügen Sie @nuxt-alt/auth und @pinia/nuxt zum modules von nuxt.config.ts hinzu

Hinweis: Sie müssen @nuxt-alt/http nicht angeben. Es wird automatisch hinzugefügt. Wenn Sie es jedoch manuell hinzufügen möchten, stellen Sie sicher, dass es sich unter dem Auth-Modul befindet (und über dem Proxy-Modul, wenn Sie es verwenden). Es braucht auch keine Pinia, es wird standardmäßig Nuxts useState verwenden.

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

Dokumentation

Dokumentation lesen

Änderungen

Das Modul verwendet jetzt '@nuxt-Alt/http', um zu funktionieren, dieses Modul erweitert OhmyFetch. Bitte beachten Sie, dass Sie jetzt body verwenden müssen, wenn Sie data zum Posten von Daten verwenden, da dies das ist, was ohmyfetch verwendet. Wenn Sie SSR verwenden möchten, sollten Sie das @nuxt-alt/proxy Modul verwenden.

Komponierbar

Ein useAuth() -Bekurs ist verfügbar, um auf die Auth -Methoden zuzugreifen.

Optionen

Die meisten Optionen werden direkt vom @nuxtjs/Auth -Modul genommen. Darüber hinaus sind einige zusätzliche Optionen verfügbar.

`globalMiddleware`

Typ: Boolean
Standard: false

Ermöglicht/deaktiviert die Middleware, die weltweit verwendet werden soll.

`enableMiddleware`

Typ: Boolean
Standard: true

Aktiviert/deaktiviert die integrierte Middleware.

`stores.state.namespace`

Typ: String
Standard: auth

Dies ist der Namespace für Nuxt Usestate.

`stores.pinia.enabled`

Typ: Boolean
Standard: false

Aktivieren useState diese Option, um den Pinia Store zu verwenden.

`stores.pinia.namespace`

Typ: String
Standard: auth

Dies ist der Namespace für den Pinia Store.

`stores.local.enabled`

Typ: Boolean
Standard: true

Aktivieren Sie diese Option, um den LocalStorage Store zu verwenden.

`stores.local.prefix`

Typ: String
Standard: auth.

Dadurch wird das lokale Storage -Präfix festgelegt.

`stores.session.enabled`

Typ: Boolean
Standard: true

Aktivieren Sie diese Option, um den SessionStorage Store zu verwenden.

`stores.session.prefix`

Typ: String
Standard: auth.

Ähnlich wie bei der LocalStorage -Option ist dies das Präfix für den Sitzungsspeicher.

`stores.cookie.enabled`

Typ: Boolean
Standard: true

Aktivieren Sie diese Option, um den Cookie -Speicher zu verwenden.

`stores.cookie.prefix`

Typ: String
Standard: auth.

Ähnlich wie bei der LocalStorage -Option ist dies das Präfix für den Cookie -Speicher.

`stores.cookie.options`

Typ: Object
Standard: { path: '/' }

Die Standard -Cookie -Speicheroptionen.

`redirectStrategy`

Typ: query | storage
Standard: storage

Die Art der Umleitungsstrategie, die Sie anwenden möchten, storage localStorage für Umleitungen und query unter Verwendung der Routenabfrageparameter.

`tokenValidationInterval`

Typ: Boolean | Number
Standard: false

Dies ist experimentell. Wenn auf TRUE eingestellt ist, beträgt das Standardintervall 1000 ms, ansonsten in Millisekunden. So oft das Modul mit Versuch, das Token für den Ablauf zu validieren.

`resetOnResponseError`

Typ: Boolean | Function
Standard: false

Wenn es aktiviert ist, wird es zurückgesetzt, wenn ein 401 -Fehler in einer der Antworten auftritt. Sie können dies in eine Funktion machen, um dies selbst zu handhaben:

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

TypeScript (2.6.0+)

Die Benutzerinformationen können wie dies für Typscript bearbeitet werden:

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

Token (Typen)

Zusätzlich zu Auth -Token;

Standardmäßig verwendet der $auth.strategy Getter den Scheme -Typ, der keine token oder refreshToken -Eigenschaftstypen hat. Um dies zu unterstützen, wurden ein $auth.refreshStrategy und ein $auth.tokenStrategy Getter zum Tippen hinzugefügt. Sie alle tun das Gleiche, das ist nur für Typ -Hinweise gedacht.