vite+vue+ts集成pinia状态管理插件

当pinia在ts环境下运行时,如果未对一些必要的变量进行类型约束时可能会到编辑器报红提示,或者无法对代码做出相应的提示。按如下方法配置可以解决相关问题

1、入口main.ts

关键行:

import { createPinia } from 'pinia'

app.use(createPinia())

import { createApp } from 'vue'
import { createPinia } from 'pinia'

import App from './App.vue'
import router from './router'

const app = createApp(App)

app.use(createPinia())
app.use(router)

app.mount('#app')

2、定义Store文件user.ts

关键行:

export interface UserStoreState {
  token: string
}
export interface UserStoreAction {
  removeToken(): void
  login(form: LoginForm): Promise<boolean>
}
export const useUserStore = defineStore<string, UserStoreState, {}, UserStoreAction>('user', {...})
import { defineStore } from 'pinia'
import { loginApi } from '@/api/users'

// 定义普通属性
export interface UserStoreState {
  token: string
}
// 定义操作方法
export interface UserStoreAction {
  removeToken(): void
  login(form: LoginForm): Promise<boolean>
}

export interface LoginForm {
  name: string,
  password: string
}

// 定义store传入对应的ts类型,其中第三参数{}为getter的数据类型
export const useUserStore = defineStore<string, UserStoreState, {}, UserStoreAction>('user', {
  state() {
    return {
      token: ''
    }
  },
  actions: {
    async login (form: LoginForm) {
      try {
        const { data } = await loginApi(form)
        this.token = data.data
        return true
      } catch (error){
        this.token = ''
        return false
      }
    },
    removeToken() {
      this.token = ''
    }
  }
})

3、在组件中使用store

// 引入相关依赖
import { useUserStore } from '@/stores/user'
import type { UserStoreAction, UserStoreState } from '@/stores/user'
import type { Store } from 'pinia'

// 获取store
const userStore: Store<string, UserStoreState, {}, UserStoreAction> = useUserStore()


// 获取store属性
const token = userStore.token

// 调用store方法
const loginAction = async () => {
  // ...
  if (!valid) return
  const isSuccess = await userStore.login(formData)
  if (isSuccess) {
    await router.push('/')
  }
  // ...
}

4、在非组件中使用store,例如请求封装axios请求的文件中

// 引入相关依赖
import axios from 'axios'
import { useUserStore } from '@/stores/user'
import type { UserStoreState, UserStoreAction } from '@/stores/user'
import type { Store } from 'pinia'


// 获取store对象 此处只是定义了未赋值,因为此处代码执行的时候可能store还未初始化完成
let userStore: Store<string, UserStoreState, {}, UserStoreAction>
/* 请求拦截器*/
request.interceptors.request.use((config) => {
  const { url } = config
  const ssoLoginUrl = '/users/login'
  // 如果store对象不存在需要在次数获取下store对象(页面加载的时候useUserStore()方法只能执行一次,后边的请求userStore就已经存在了)
  if (!userStore) userStore = useUserStore()
  // 获取store对象中的属性
  const { token } = userStore
  if (ssoLoginUrl !== url && token) {
    config.headers.Authorization = token
  }
  return config
})

  • 6
    点赞
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
对于使用 Vite + Vue3 + TypeScript + Pinia + Vue Router + Axios + SCSS 并自动导入 API 的设置,你可以按照以下步骤进行操作: 1. 首先,确保你已经安装了 Node.js,并且版本大于等于 12.0.0。 2. 创建一个新的 Vue 项目,可以使用 Vue CLI 或者手动创建一个空文件夹。 3. 在项目根目录下,打开终端并执行以下命令安装 Vite: ```bash npm init vite@latest ``` 按照提示选择你的项目配置,包括选择 Vue 3、TypeScript 和其他选项。 4. 进入项目目录并安装依赖: ```bash cd your-project-name npm install ``` 5. 安装 Pinia 插件: ```bash npm install pinia ``` 6. 创建一个 `src/store` 目录,并在其中创建 `index.ts` 文件,用于定义和导出你的 Pinia store。 ```typescript // src/store/index.ts import { createPinia } from 'pinia' export const store = createPinia() // 可以在这里定义你的 store 模块 ``` 7. 在项目根目录下创建 `src/api` 目录,用于存放 API 请求相关的文件。 8. 在 `src/api` 目录下创建一个 `index.ts` 文件,用于自动导入所有 API 文件。 ```typescript // src/api/index.ts const modules = import.meta.globEager('./*.ts') const apis: any = {} for (const path in modules) { if (path !== './index.ts') { const moduleName = path.replace(/^.\/|\.ts$/g, '') apis[moduleName] = modules[path].default } } export default apis ``` 这样,你就可以在 `src/api` 目录下创建各种 API 请求的文件,例如 `user.ts`: ```typescript // src/api/user.ts import axios from 'axios' export function getUser(id: number) { return axios.get(`/api/user/${id}`) } ``` 然后,在你的组件中使用自动导入的 API: ```typescript import { defineComponent, ref } from 'vue' import { useUserStore } from '@/store' import apis from '@/api' export default defineComponent({ setup() { const userStore = useUserStore() const userId = ref(1) const fetchUser = async () => { const response = await apis.user.getUser(userId.value) userStore.setUser(response.data) } return { userId, fetchUser, } }, }) ``` 以上就是使用 Vite + Vue3 + TypeScript + Pinia + Vue Router + Axios + SCSS 并自动导入 API 的基本设置。你可以根据自己的需求进一步配置和扩展。希望对你有所帮助!
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值