跳转到内容

升级到 0.8.0

此版本包含**所有提供程序**的重大更改。

安装

bash
npm i -D @sidebase/nuxt-auth@^0.8.0
bash
pnpm i -D @sidebase/nuxt-auth^0.8.0
bash
yarn add --dev @sidebase/nuxt-auth^0.8.0

重大更改

  • auth.session 重命名为 auth.sessionRefresh
ts
// nuxt.config.ts

export default defineNuxtConfig({
  modules: ['@sidebase/nuxt-auth'],
  auth: {
    session: { 
      enableRefreshOnWindowFocus: true, 
      enableRefreshPeriodically: 10000, 
    }, 
    sessionRefresh: { 
      enableOnWindowFocus: true, 
      enablePeriodically: 10000, 
    }, 
  }
})

RefreshHandler

#715 中,我们迈出了第一步,以改进应用程序刷新行为并增加自定义的可能性。在 #766 中,我们最终完成了这些更改,并改进了之前的配置选项。您可以在 Nuxt 配置中的 auth.sessionRefresh.refreshHandler 下定义自定义 RefreshHandler 的位置。

要自定义会话刷新,您可以提供一个刷新处理程序。自定义 RefreshHandler 需要一个 init 和一个 destroy 函数。

  • 当 nuxt 应用程序挂载时,将调用 init。您可以在此处添加事件侦听器并初始化自定义刷新行为。该方法将接收一个 RefreshHandlerConfig。类型包括 enablePeriodicallyenableOnWindowFocus
  • 当您的应用程序卸载时,将调用 destroy。您可以在此处运行清理程序,例如删除事件侦听器。
ts
import type { RefreshHandler } from '@sidebase/nuxt-auth'

// You may also use a plain object with `satisfies RefreshHandler`, of course!
class CustomRefreshHandler implements RefreshHandler {
  init(): void {
    console.info('Use the full power of classes to customize refreshHandler!')
  }

  destroy(): void {
    console.info(
      'Hover above class properties or go to their definition '
      + 'to learn more about how to craft a refreshHandler'
    )
  }
}

export default new CustomRefreshHandler()

更新日志

完整更新日志: https://github.com/sidebase/nuxt-auth/compare/0.7.2...0.8.0

在 MIT 许可证下发布。