Browse Source

docs(订单地址): 完善客户地址相关类型定义注释

yz 2 months ago
parent
commit
79c5b28a25
1 changed files with 47 additions and 3 deletions
  1. 47 3
      src/views/order/address/index.vue

+ 47 - 3
src/views/order/address/index.vue

@@ -53,9 +53,53 @@ import { getList, add, update, remove, getDetail } from '@/api/order/address'
 import { mapGetters } from 'vuex'
 
 /**
- * @typedef {import('@/api/order/address').CustomerAddressItem} CustomerAddressItem
- * @typedef {import('@/api/order/address').CustomerAddressForm} CustomerAddressForm
- * @typedef {import('@/api/order/address').CustomerAddressQueryParams} CustomerAddressQueryParams
+ * 客户地址查询参数
+ * @typedef {Object} CustomerAddressQueryParams
+ * @property {string} [customerCode] - 客户编码
+ * @property {string} [customerName] - 客户名称
+ * @property {string} [receiverName] - 收货人姓名
+ * @property {string} [receiverPhone] - 收货人电话
+ * @property {string} [regionName] - 地区名称
+ * @property {number} [isDefault] - 是否默认地址 0-否 1-是
+ * @property {number} [isActive] - 状态 0-禁用 1-启用
+ */
+
+/**
+ * 客户地址表单数据
+ * @typedef {Object} CustomerAddressForm
+ * @property {number} [id] - 地址ID
+ * @property {number} customerId - 客户ID
+ * @property {string} customerCode - 客户编码
+ * @property {string} customerName - 客户名称
+ * @property {string} receiverName - 收货人姓名
+ * @property {string} receiverPhone - 收货人电话
+ * @property {string} regionCode - 地区编码
+ * @property {string} regionName - 地区名称
+ * @property {string} detailAddress - 详细地址
+ * @property {string} [postalCode] - 邮政编码
+ * @property {number} isDefault - 是否默认地址 0-否 1-是
+ * @property {number} isActive - 状态 0-禁用 1-启用
+ * @property {string} [createTime] - 创建时间
+ * @property {string} [updateTime] - 更新时间
+ */
+
+/**
+ * 客户地址列表项
+ * @typedef {Object} CustomerAddressItem
+ * @property {number} id - 地址ID
+ * @property {number} customerId - 客户ID
+ * @property {string} customerCode - 客户编码
+ * @property {string} customerName - 客户名称
+ * @property {string} receiverName - 收货人姓名
+ * @property {string} receiverPhone - 收货人电话
+ * @property {string} regionCode - 地区编码
+ * @property {string} regionName - 地区名称
+ * @property {string} detailAddress - 详细地址
+ * @property {string} postalCode - 邮政编码
+ * @property {number} isDefault - 是否默认地址 0-否 1-是
+ * @property {number} isActive - 状态 0-禁用 1-启用
+ * @property {string} createTime - 创建时间
+ * @property {string} updateTime - 更新时间
  */
 
 export default {