From f87a9d9918a2f070f94189d9a3f2a553625f8671 Mon Sep 17 00:00:00 2001 From: Kaifuny Date: Mon, 24 Jul 2023 12:34:23 +0800 Subject: [PATCH] add: store description(README.md) Signed-off-by: Kaifuny --- .../packages/modules/common/src/store/README.md | 11 ++++++++++- .../modules/common/src/store/modules/apperance.ts | 4 ++-- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/contact-frontend/packages/modules/common/src/store/README.md b/contact-frontend/packages/modules/common/src/store/README.md index 9b763c48..f02ea519 100644 --- a/contact-frontend/packages/modules/common/src/store/README.md +++ b/contact-frontend/packages/modules/common/src/store/README.md @@ -1 +1,10 @@ -# 说明 \ No newline at end of file +# @cskefu/common + +> 封装了整个业务层的逻辑 (包括：数据获取、数据处理、数据存储等) +> 为方便以后通过全局搜索框进行操作，使用 pinia，请确保界面操作命令实现的功能与命令行操作一致 + +## 目录结构 + +* module 为模块，一个模块对应一个 store，一个 store 对应一个模块 +* action 为模块的 action，一个 action 对应一个执行命令指令 (通常以 ``do`` 开头) +* getter 为模块的 getter，一个 getter 对应一个获取命令指令 (通常以 ``get / is`` 开头) diff --git a/contact-frontend/packages/modules/common/src/store/modules/apperance.ts b/contact-frontend/packages/modules/common/src/store/modules/apperance.ts index 5716ddaa..93926bc4 100644 --- a/contact-frontend/packages/modules/common/src/store/modules/apperance.ts +++ b/contact-frontend/packages/modules/common/src/store/modules/apperance.ts @@ -14,10 +14,10 @@ export const useApperance = defineStore('alerts', { getLang: (state) => state.apperance.lang, }, actions: { - toggleDarkMode() { + doToggleDarkMode() { this.apperance.darkMode = !this.apperance.darkMode }, - setLang(lang: string) { + doSetLang(lang: string) { this.apperance.lang = lang }, },