ruoyi-plus-vben5/packages/effects
handsomeFu d5655f02e3
chore(docs): update function parameter comments (#4215)
* docs(other): update function parameters jsdoc

- 移除`vue-router.d.ts`中`activePath`属性的默认值注释。
- 重构`generateRoutes`函数签名,增加`options`参数。
- 调整`authLogin`函数文档,增加`onSuccess`回调函数的说明。

* docs: 删除 `activePath` 属性的默认值注释

在路线文档中,移除了`activePath`属性的默认值注释,以清晰说明其行为。此更改更新了文档内容,使其更准确地反映代码实现。
2024-08-22 21:52:44 +08:00
..
access chore(docs): update function parameter comments (#4215) 2024-08-22 21:52:44 +08:00
chart-ui chore(deps): bump the non-breaking-changes group with 8 updates (#4195) 2024-08-20 10:16:56 +08:00
common-ui chore(deps): bump the non-breaking-changes group with 8 updates (#4195) 2024-08-20 10:16:56 +08:00
hooks fix: element-plus styles (#4203) 2024-08-20 21:53:09 +08:00
layouts chore(docs): updated title slot description (#4192) 2024-08-22 21:48:05 +08:00
request chore: release v5.1.1 [skip ci] 2024-08-19 23:32:24 +08:00
README.md refactor: adjust all sample pages and use page components (#4118) 2024-08-11 20:05:52 +08:00

Effects 目录

effects 目录专门用于存放与轻微耦合相关的代码和逻辑。如果你的包具有以下特点,建议将其放置在 effects 目录下:

  • 状态管理:使用状态管理框架 pinia并包含处理副作用如异步操作、API 调用)的部分。
  • 用户偏好设置:使用 @vben-core/preferences 处理用户偏好设置,涉及本地存储或浏览器缓存逻辑(如使用 localStorage)。
  • 导航和路由:处理导航、页面跳转等场景,需要管理路由变化的逻辑。
  • 组件库依赖:包含与特定组件库紧密耦合或依赖大型仓库的部分。

通过将相关代码归类到 effects 目录,可以使项目结构更加清晰,便于维护和扩展。