sheng/mes-ui-d2
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

统一注释

Browse Source 
Former-commit-id: 84696fcb55852443b9c60211e9fd1b3cd8610968 [formerly 84696fcb55852443b9c60211e9fd1b3cd8610968 [formerly 84696fcb55852443b9c60211e9fd1b3cd8610968 [formerly 84696fcb55852443b9c60211e9fd1b3cd8610968 [formerly dfcac6903fac04b8506e7590162e5a534f708d3e [formerly a7bee713a1d6b6f6e9c2638ebfdcab241ac98d8d]]]]]
Former-commit-id: 2fd44bb55cb052776b8d13e3619ac467d28cfae5
Former-commit-id: 0b0091d3623441b860ea5ebd5473f940c38dbd5d
Former-commit-id: b7c16508cc73b0e21a998594c641027a15725e97 [formerly c0f4da610591404663be3991a505bb91a154ca24]
Former-commit-id: 6a65b8abd337142301552e8d07ac77fb7ba527a6
Former-commit-id: 3e88bb356257d298419021cc613ec153af7e033e
Former-commit-id: 234c54e019fd3847c06647ae01ba88eac3c38344
Former-commit-id: 6425245ee4e4a5b6fee961f2ea44f51568745b97
Former-commit-id: 930bd2ecd955a8f91fabcd414af1aa628fc61f96
This commit is contained in:
FairyEver
2019-08-20 22:15:25 +08:00
parent e06e720b38
commit 30e80f2257
16 changed files with 88 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
src/libs/util.db.js
View File

@@ -17,11 +17,11 @@ export default db
/** /**
* @description 检查路径是否存在 不存在的话初始化 * @description 检查路径是否存在 不存在的话初始化
* @param {Object} param dbName {String} 数据库名称 * @param {Object} payload dbName {String} 数据库名称
* @param {Object} param path {String} 路径 * @param {Object} payload path {String} 路径
* @param {Object} param user {Boolean} 区分用户 * @param {Object} payload user {Boolean} 区分用户
* @param {Object} param validator {Function} 数据校验钩子 返回 true 表示验证通过 * @param {Object} payload validator {Function} 数据校验钩子 返回 true 表示验证通过
* @param {Object} param defaultValue {*} 初始化默认值 * @param {Object} payload defaultValue {*} 初始化默认值
* @returns {String} 可以直接使用的路径 * @returns {String} 可以直接使用的路径
*/ */
export function pathInit ({ export function pathInit ({
@@ -45,10 +45,10 @@ export function pathInit ({
/** /**
* @description 将数据存储到指定位置 | 路径不存在会自动初始化 * @description 将数据存储到指定位置 | 路径不存在会自动初始化
* @description 效果类似于取值 dbName.path = value * @description 效果类似于取值 dbName.path = value
* @param {Object} param dbName {String} 数据库名称 * @param {Object} payload dbName {String} 数据库名称
* @param {Object} param path {String} 存储路径 * @param {Object} payload path {String} 存储路径
* @param {Object} param value {*} 需要存储的值 * @param {Object} payload value {*} 需要存储的值
* @param {Object} param user {Boolean} 是否区分用户 * @param {Object} payload user {Boolean} 是否区分用户
*/ */
export function dbSet ({ export function dbSet ({
dbName = 'database', dbName = 'database',
@@ -66,10 +66,10 @@ export function dbSet ({
/** /**
* @description 获取数据 * @description 获取数据
* @description 效果类似于取值 dbName.path || defaultValue * @description 效果类似于取值 dbName.path || defaultValue
* @param {Object} param dbName {String} 数据库名称 * @param {Object} payload dbName {String} 数据库名称
* @param {Object} param path {String} 存储路径 * @param {Object} payload path {String} 存储路径
* @param {Object} param defaultValue {*} 取值失败的默认值 * @param {Object} payload defaultValue {*} 取值失败的默认值
* @param {Object} param user {Boolean} 是否区分用户 * @param {Object} payload user {Boolean} 是否区分用户
*/ */
export function dbGet ({ export function dbGet ({
dbName = 'database', dbName = 'database',
@@ -89,7 +89,7 @@ export function dbGet ({
/** /**
* @description 获取存储数据库对象 * @description 获取存储数据库对象
* @param {Object} param user {Boolean} 是否区分用户 * @param {Object} payload user {Boolean} 是否区分用户
*/ */
export function database ({ export function database ({
dbName = 'database', dbName = 'database',

14
src/store/modules/d2admin/modules/account.js
View File

@@ -8,10 +8,10 @@ export default {
actions: { actions: {
/** /**
* @description 登录 * @description 登录
* @param {Object} param context * @param {Object} context
* @param {Object} param username {String} 用户账号 * @param {Object} payload username {String} 用户账号
* @param {Object} param password {String} 密码 * @param {Object} payload password {String} 密码
* @param {Object} param route {Object} 登录成功后定向的路由对象 任何 vue-router 支持的格式 * @param {Object} payload route {Object} 登录成功后定向的路由对象 任何 vue-router 支持的格式
*/ */
login ({ dispatch }, { login ({ dispatch }, {
username = '', username = '',
@@ -48,8 +48,8 @@ export default {
}, },
/** /**
* @description 注销用户并返回登录页面 * @description 注销用户并返回登录页面
* @param {Object} param context * @param {Object} context
* @param {Object} param confirm {Boolean} 是否需要确认 * @param {Object} payload confirm {Boolean} 是否需要确认
*/ */
logout ({ commit, dispatch }, { confirm = false } = {}) { logout ({ commit, dispatch }, { confirm = false } = {}) {
/** /**
@@ -90,7 +90,7 @@ export default {
}, },
/** /**
* @description 用户登录后从持久化数据加载一系列的设置 * @description 用户登录后从持久化数据加载一系列的设置
* @param {Object} state vuex state * @param {Object} context
*/ */
load ({ dispatch }) { load ({ dispatch }) {
return new Promise(async resolve => { return new Promise(async resolve => {

9
src/store/modules/d2admin/modules/color.js
View File

@@ -10,7 +10,7 @@ export default {
actions: { actions: {
/** /**
* @description 设置颜色 * @description 设置颜色
* @param {Object} state vuex state * @param {Object} context
* @param {String} color 尺寸 * @param {String} color 尺寸
*/ */
set ({ state, dispatch, commit }, color) { set ({ state, dispatch, commit }, color) {
@@ -37,7 +37,7 @@ export default {
}, },
/** /**
* @description 从持久化数据读取颜色设置 * @description 从持久化数据读取颜色设置
* @param {Object} state vuex state * @param {Object} context
*/ */
load ({ state, dispatch, commit }) { load ({ state, dispatch, commit }) {
return new Promise(async resolve => { return new Promise(async resolve => {
@@ -63,8 +63,9 @@ export default {
mutations: { mutations: {
/** /**
* @description 将 vuex 中的主题颜色设置应用到系统中 * @description 将 vuex 中的主题颜色设置应用到系统中
* @param {Object} state vuex state * @param {Object} context
* @param {Object} payload 设置 * @param {Object} payload oldColor {String} 旧的颜色
* @param {Object} payload newColor {String} 新颜色
*/ */
apply (state, { oldColor, newColor }) { apply (state, { oldColor, newColor }) {
var options = { var options = {

62
src/store/modules/d2admin/modules/db.js
View File

@@ -8,11 +8,11 @@ export default {
/** /**
* @description 将数据存储到指定位置 | 路径不存在会自动初始化 * @description 将数据存储到指定位置 | 路径不存在会自动初始化
* @description 效果类似于取值 dbName.path = value * @description 效果类似于取值 dbName.path = value
* @param {Object} context context * @param {Object} context
* @param {Object} param dbName {String} 数据库名称 * @param {Object} payload dbName {String} 数据库名称
* @param {Object} param path {String} 存储路径 * @param {Object} payload path {String} 存储路径
* @param {Object} param value {*} 需要存储的值 * @param {Object} payload value {*} 需要存储的值
* @param {Object} param user {Boolean} 是否区分用户 * @param {Object} payload user {Boolean} 是否区分用户
*/ */
set (context, { set (context, {
dbName = 'database', dbName = 'database',
@@ -25,11 +25,11 @@ export default {
/** /**
* @description 获取数据 * @description 获取数据
* @description 效果类似于取值 dbName.path || defaultValue * @description 效果类似于取值 dbName.path || defaultValue
* @param {Object} context context * @param {Object} context
* @param {Object} param dbName {String} 数据库名称 * @param {Object} payload dbName {String} 数据库名称
* @param {Object} param path {String} 存储路径 * @param {Object} payload path {String} 存储路径
* @param {Object} param defaultValue {*} 取值失败的默认值 * @param {Object} payload defaultValue {*} 取值失败的默认值
* @param {Object} param user {Boolean} 是否区分用户 * @param {Object} payload user {Boolean} 是否区分用户
*/ */
get (context, { get (context, {
dbName = 'database', dbName = 'database',
@@ -41,8 +41,8 @@ export default {
}, },
/** /**
* @description 获取存储数据库对象 * @description 获取存储数据库对象
* @param {Object} context context * @param {Object} context
* @param {Object} param user {Boolean} 是否区分用户 * @param {Object} payload user {Boolean} 是否区分用户
*/ */
database (context, { database (context, {
user = false user = false
@@ -54,8 +54,8 @@ export default {
}, },
/** /**
* @description 清空存储数据库对象 * @description 清空存储数据库对象
* @param {Object} context context * @param {Object} context
* @param {Object} param user {Boolean} 是否区分用户 * @param {Object} payload user {Boolean} 是否区分用户
*/ */
databaseClear (context, { databaseClear (context, {
user = false user = false
@@ -68,9 +68,9 @@ export default {
}, },
/** /**
* @description 获取存储数据库对象 [ 区分页面 ] * @description 获取存储数据库对象 [ 区分页面 ]
* @param {Object} context context * @param {Object} context
* @param {Object} param basis {String} 页面区分依据 [ name | path | fullPath ] * @param {Object} payload basis {String} 页面区分依据 [ name | path | fullPath ]
* @param {Object} param user {Boolean} 是否区分用户 * @param {Object} payload user {Boolean} 是否区分用户
*/ */
databasePage (context, { databasePage (context, {
basis = 'fullPath', basis = 'fullPath',
@@ -84,9 +84,9 @@ export default {
}, },
/** /**
* @description 清空存储数据库对象 [ 区分页面 ] * @description 清空存储数据库对象 [ 区分页面 ]
* @param {Object} context context * @param {Object} context
* @param {Object} param basis {String} 页面区分依据 [ name | path | fullPath ] * @param {Object} payload basis {String} 页面区分依据 [ name | path | fullPath ]
* @param {Object} param user {Boolean} 是否区分用户 * @param {Object} payload user {Boolean} 是否区分用户
*/ */
databasePageClear (context, { databasePageClear (context, {
basis = 'fullPath', basis = 'fullPath',
@@ -101,10 +101,10 @@ export default {
}, },
/** /**
* @description 快速将页面当前的数据 ( $data ) 持久化 * @description 快速将页面当前的数据 ( $data ) 持久化
* @param {Object} context context * @param {Object} context
* @param {Object} param instance {Object} vue 实例 * @param {Object} payload instance {Object} vue 实例
* @param {Object} param basis {String} 页面区分依据 [ name | path | fullPath ] * @param {Object} payload basis {String} 页面区分依据 [ name | path | fullPath ]
* @param {Object} param user {Boolean} 是否区分用户 * @param {Object} payload user {Boolean} 是否区分用户
*/ */
pageSet (context, { pageSet (context, {
instance, instance,
@@ -120,10 +120,10 @@ export default {
}, },
/** /**
* @description 快速获取页面快速持久化的数据 * @description 快速获取页面快速持久化的数据
* @param {Object} context context * @param {Object} context
* @param {Object} param instance {Object} vue 实例 * @param {Object} payload instance {Object} vue 实例
* @param {Object} param basis {String} 页面区分依据 [ name | path | fullPath ] * @param {Object} payload basis {String} 页面区分依据 [ name | path | fullPath ]
* @param {Object} param user {Boolean} 是否区分用户 * @param {Object} payload user {Boolean} 是否区分用户
*/ */
pageGet (context, { pageGet (context, {
instance, instance,
@@ -138,9 +138,9 @@ export default {
}, },
/** /**
* @description 清空页面快照 * @description 清空页面快照
* @param {Object} context context * @param {Object} context
* @param {Object} param basis {String} 页面区分依据 [ name | path | fullPath ] * @param {Object} payload basis {String} 页面区分依据 [ name | path | fullPath ]
* @param {Object} param user {Boolean} 是否区分用户 * @param {Object} payload user {Boolean} 是否区分用户
*/ */
pageClear (context, { pageClear (context, {
basis = 'fullPath', basis = 'fullPath',

4
src/store/modules/d2admin/modules/fullscreen.js
View File

@@ -9,6 +9,7 @@ export default {
actions: { actions: {
/** /**
* @description 初始化监听 * @description 初始化监听
* @param {Object} context
*/ */
listen ({ commit }) { listen ({ commit }) {
return new Promise(resolve => { return new Promise(resolve => {
@@ -26,6 +27,7 @@ export default {
}, },
/** /**
* @description 切换全屏 * @description 切换全屏
* @param {Object} context
*/ */
toggle ({ commit }) { toggle ({ commit }) {
return new Promise(resolve => { return new Promise(resolve => {
@@ -44,7 +46,7 @@ export default {
mutations: { mutations: {
/** /**
* @description 设置 store 里的全屏状态 * @description 设置 store 里的全屏状态
* @param {Object} state vuex state * @param {Object} state state
* @param {Boolean} active active * @param {Boolean} active active
*/ */
set (state, active) { set (state, active) {

4
src/store/modules/d2admin/modules/gray.js
View File

@@ -7,14 +7,14 @@ export default {
mutations: { mutations: {
/** /**
* @description 切换灰度状态 * @description 切换灰度状态
* @param {Object} state vuex state * @param {Object} state state
*/ */
toggle (state) { toggle (state) {
state.active = !state.active state.active = !state.active
}, },
/** /**
* @description 设置灰度模式 * @description 设置灰度模式
* @param {Object} state vuex state * @param {Object} state state
* @param {Boolean} active active * @param {Boolean} active active
*/ */
set (state, active) { set (state, active) {

7
src/store/modules/d2admin/modules/log.js
View File

@@ -32,9 +32,10 @@ export default {
actions: { actions: {
/** /**
* @description 添加一个日志 * @description 添加一个日志
* @param {Object} context
* @param {String} param message {String} 信息 * @param {String} param message {String} 信息
* @param {String} param type {String} 类型 * @param {String} param type {String} 类型
* @param {Object} param meta {Object} 附带的信息 * @param {Object} payload meta {Object} 附带的信息
*/ */
push ({ rootState, commit }, { message, type = 'info', meta }) { push ({ rootState, commit }, { message, type = 'info', meta }) {
commit('push', { commit('push', {
@@ -59,7 +60,7 @@ export default {
mutations: { mutations: {
/** /**
* @description 添加日志 * @description 添加日志
* @param {Object} state vuex state * @param {Object} state state
* @param {Object} log data * @param {Object} log data
*/ */
push (state, log) { push (state, log) {
@@ -67,7 +68,7 @@ export default {
}, },
/** /**
* @description 清空日志 * @description 清空日志
* @param {Object} state vuex state * @param {Object} state state
*/ */
clean (state) { clean (state) {
// store 赋值 // store 赋值

10
src/store/modules/d2admin/modules/menu.js
View File

@@ -30,7 +30,7 @@ export default {
actions: { actions: {
/** /**
* 设置侧边栏展开或者收缩 * 设置侧边栏展开或者收缩
* @param {Object} state vuex state * @param {Object} context
* @param {Boolean} collapse is collapse * @param {Boolean} collapse is collapse
*/ */
asideCollapseSet ({ state, dispatch }, collapse) { asideCollapseSet ({ state, dispatch }, collapse) {
@@ -50,7 +50,7 @@ export default {
}, },
/** /**
* 切换侧边栏展开和收缩 * 切换侧边栏展开和收缩
* @param {Object} state vuex state * @param {Object} context
*/ */
asideCollapseToggle ({ state, dispatch }) { asideCollapseToggle ({ state, dispatch }) {
return new Promise(async resolve => { return new Promise(async resolve => {
@@ -69,7 +69,7 @@ export default {
}, },
/** /**
* 从持久化数据读取侧边栏展开或者收缩 * 从持久化数据读取侧边栏展开或者收缩
* @param {Object} state vuex state * @param {Object} context
*/ */
asideCollapseLoad ({ state, dispatch }) { asideCollapseLoad ({ state, dispatch }) {
return new Promise(async resolve => { return new Promise(async resolve => {
@@ -88,7 +88,7 @@ export default {
mutations: { mutations: {
/** /**
* @description 设置顶栏菜单 * @description 设置顶栏菜单
* @param {Object} state vuex state * @param {Object} state state
* @param {Array} menu menu setting * @param {Array} menu menu setting
*/ */
headerSet (state, menu) { headerSet (state, menu) {
@@ -97,7 +97,7 @@ export default {
}, },
/** /**
* @description 设置侧边栏菜单 * @description 设置侧边栏菜单
* @param {Object} state vuex state * @param {Object} state state
* @param {Array} menu menu setting * @param {Array} menu menu setting
*/ */
asideSet (state, menu) { asideSet (state, menu) {

2
src/store/modules/d2admin/modules/page.js.REMOVED.git-id
View File

@@ -1 +1 @@
f6db6b641667fe94ef45b30706bc285c62e33d1b 98fef2a08200b7f751bbfef385cd47f54bc8ce5c

2
src/store/modules/d2admin/modules/releases.js
View File

@@ -5,7 +5,7 @@ export default {
mutations: { mutations: {
/** /**
* @description 显示版本信息 * @description 显示版本信息
* @param {Object} state vuex state * @param {Object} state state
*/ */
versionShow () { versionShow () {
util.log.capsule('D2Admin', `v${process.env.VUE_APP_VERSION}`) util.log.capsule('D2Admin', `v${process.env.VUE_APP_VERSION}`)

6
src/store/modules/d2admin/modules/search.js
View File

@@ -16,14 +16,14 @@ export default {
mutations: { mutations: {
/** /**
* @description 切换激活状态 * @description 切换激活状态
* @param {Object} state vuex state * @param {Object} state state
*/ */
toggle (state) { toggle (state) {
state.active = !state.active state.active = !state.active
}, },
/** /**
* @description 设置激活模式 * @description 设置激活模式
* @param {Object} state vuex state * @param {Object} state state
* @param {Boolean} active active * @param {Boolean} active active
*/ */
set (state, active) { set (state, active) {
@@ -31,7 +31,7 @@ export default {
}, },
/** /**
* @description 初始化 * @description 初始化
* @param {Object} state vuex state * @param {Object} state state
* @param {Array} menu menu * @param {Array} menu menu
*/ */
init (state, menu) { init (state, menu) {

6
src/store/modules/d2admin/modules/size.js
View File

@@ -10,6 +10,7 @@ export default {
actions: { actions: {
/** /**
* @description 将当前的设置应用到 element * @description 将当前的设置应用到 element
* @param {Object} context
* @param {Boolean} refresh 是否在设置之后刷新页面 * @param {Boolean} refresh 是否在设置之后刷新页面
*/ */
apply ({ state, commit }, refresh) { apply ({ state, commit }, refresh) {
@@ -21,6 +22,7 @@ export default {
}, },
/** /**
* @description 确认已经加载组件尺寸设置 https://github.com/d2-projects/d2-admin/issues/198 * @description 确认已经加载组件尺寸设置 https://github.com/d2-projects/d2-admin/issues/198
* @param {Object} context
*/ */
isLoaded ({ state }) { isLoaded ({ state }) {
if (state.value) return Promise.resolve() if (state.value) return Promise.resolve()
@@ -34,7 +36,7 @@ export default {
}, },
/** /**
* @description 设置尺寸 * @description 设置尺寸
* @param {Object} state vuex state * @param {Object} context
* @param {String} size 尺寸 * @param {String} size 尺寸
*/ */
set ({ state, dispatch }, size) { set ({ state, dispatch }, size) {
@@ -56,7 +58,7 @@ export default {
}, },
/** /**
* @description 从持久化数据读取尺寸设置 * @description 从持久化数据读取尺寸设置
* @param {Object} state vuex state * @param {Object} context
*/ */
load ({ state, dispatch }) { load ({ state, dispatch }) {
return new Promise(async resolve => { return new Promise(async resolve => {

8
src/store/modules/d2admin/modules/theme.js
View File

@@ -12,7 +12,7 @@ export default {
getters: { getters: {
/** /**
* @description 返回当前的主题信息 不是一个名字 而是当前激活主题的所有数据 * @description 返回当前的主题信息 不是一个名字 而是当前激活主题的所有数据
* @param {Object} state vuex state * @param {Object} state state
*/ */
activeSetting (state) { activeSetting (state) {
return state.list.find(theme => theme.name === state.activeName) return state.list.find(theme => theme.name === state.activeName)
@@ -21,7 +21,6 @@ export default {
actions: { actions: {
/** /**
* @description 激活一个主题 * @description 激活一个主题
* @param {Object} state vuex state
* @param {String} themeValue 需要激活的主题名称 * @param {String} themeValue 需要激活的主题名称
*/ */
set ({ state, commit, dispatch }, themeName) { set ({ state, commit, dispatch }, themeName) {
@@ -42,8 +41,7 @@ export default {
}) })
}, },
/** /**
* @description 从持久化数据加载主题设置 * @description 从持久化数据加载主题设置 * @param {Object} context
* @param {Object} state vuex state
*/ */
load ({ state, commit, dispatch }) { load ({ state, commit, dispatch }) {
return new Promise(async resolve => { return new Promise(async resolve => {
@@ -77,7 +75,7 @@ export default {
mutations: { mutations: {
/** /**
* @description 将 vuex 中的主题应用到 dom * @description 将 vuex 中的主题应用到 dom
* @param {Object} state vuex state * @param {Object} state state
*/ */
dom (state) { dom (state) {
document.body.className = `theme-${state.activeName}` document.body.className = `theme-${state.activeName}`

4
src/store/modules/d2admin/modules/transition.js
View File

@@ -10,7 +10,7 @@ export default {
actions: { actions: {
/** /**
* @description 设置开启状态 * @description 设置开启状态
* @param {Object} state vuex state * @param {Object} context
* @param {Boolean} active 新的状态 * @param {Boolean} active 新的状态
*/ */
set ({ state, dispatch }, active) { set ({ state, dispatch }, active) {
@@ -30,7 +30,7 @@ export default {
}, },
/** /**
* 从数据库读取页面过渡动画设置 * 从数据库读取页面过渡动画设置
* @param {Object} state vuex state * @param {Object} context
*/ */
load ({ state, dispatch }) { load ({ state, dispatch }) {
return new Promise(async resolve => { return new Promise(async resolve => {

2
src/store/modules/d2admin/modules/ua.js
View File

@@ -9,7 +9,7 @@ export default {
mutations: { mutations: {
/** /**
* @description 记录 UA * @description 记录 UA
* @param {Object} state vuex state * @param {Object} state state
*/ */
get (state) { get (state) {
state.data = new UaParser().getResult() state.data = new UaParser().getResult()

4
src/store/modules/d2admin/modules/user.js
View File

@@ -7,7 +7,7 @@ export default {
actions: { actions: {
/** /**
* @description 设置用户数据 * @description 设置用户数据
* @param {Object} state vuex state * @param {Object} context
* @param {*} info info * @param {*} info info
*/ */
set ({ state, dispatch }, info) { set ({ state, dispatch }, info) {
@@ -27,7 +27,7 @@ export default {
}, },
/** /**
* @description 从数据库取用户数据 * @description 从数据库取用户数据
* @param {Object} state vuex state * @param {Object} context
*/ */
load ({ state, dispatch }) { load ({ state, dispatch }) {
return new Promise(async resolve => { return new Promise(async resolve => {