接口类型使用

概述

可以通过type的方式引入homing的类型，提供完整的TypeScript支持。

基本用法

// typescript^4
import type { GetSmsCodeRes } from '@homing/web'

client.getSmsCode({
  mobile: '123456',
}).then((res: GetSmsCodeRes) => {
  console.log(res, '短信验证码 res: expireIn 验证码超时时长（秒）');
}).catch(err => {
  console.log(err, '短信验证码--err');
})

常用类型

1. 请求类型

import type { 
  GetSmsCodeReq,
  LoginBySmsCodeReq,
  GetUserInfoReq,
  GetEmployeeListReq
} from '@homing/web'

2. 响应类型

import type { 
  GetSmsCodeRes,
  LoginBySmsCodeRes,
  GetUserInfoRes,
  GetEmployeeListRes
} from '@homing/web'

3. 错误类型

import type { BizErrInfo } from '@homing/web'

类型使用示例

登录接口

import type { LoginBySmsCodeReq, LoginBySmsCodeRes } from '@homing/web'

const loginData: LoginBySmsCodeReq = {
  mobile: '13800138000',
  smsCode: '123456',
  orgId: 123
};

try {
  const result: LoginBySmsCodeRes = await homingClient.loginBySmsCode(loginData);
  console.log('登录成功', result);
} catch (error: BizErrInfo) {
  console.error('登录失败', error.message);
}

获取用户信息

import type { GetUserInfoRes } from '@homing/web'

const userInfo: GetUserInfoRes = await homingClient.getUserInfo();
console.log('用户信息', userInfo);

类型检查

使用TypeScript可以获得以下好处：

1. 编译时检查 - 在编译时发现类型错误
2. 智能提示 - IDE提供准确的代码提示
3. 重构安全 - 重构时自动更新相关引用
4. 文档即代码 - 类型定义本身就是最好的文档

注意事项

1. 确保TypeScript版本 >= 4.0
2. 使用 import type 语法导入类型
3. 在catch块中正确处理错误类型
4. 为复杂对象定义明确的类型注解