ruoyi-plus-soybean/doc/TS写法规范.md
2021-11-10 20:48:55 +08:00

787 B
Raw Blame History

1.interface和type

interface和type使用优先级能用interface表示的类型就用interface。

2.请求函数

api接口

统一以 fetch 开头,例如:

/**
 * 获取用户信息
 * @param id - 用户唯一标识id
 */
function fetchUserInfo(idstring) {
	// ***
}
/**
 * 删除列表项
 * @param id - 列表id
 */
function fetchDeleteListItem(idstring) {
	// ***
}

middleware中间件

统一以 handle 开头,例如

/**接口返回的用户信息 */
interface ResponseUserInfo {
  userId: string;
  userName: string;
  userAge: number;
}
/**
 * 获取用户信息 中间件
 @param data - 返回的用户信息
 */
function handleUserInfo(data: ResponseUserInfo): UserInfo {
  // ***
}