Skip to content

接入流程

1. 引入NPM包

bash
# 公开版
npm install @homing/web
# beta版
npm install @homing/web@beta

2. SDK初始化

typescript
import { HomingClient } from '@homing/web';

interface BizErrInfo {
  /** 提示信息 */
  message: string;
  /** 服务端状态码 */
  statusCode?: number;
  /** 业务错误码 */
  apiCode?: number;
};

interface HomingConfig {
  /** 鸿溟应用code */
  appCode: string;
  /** 鸿溟应用类型 */
  appType: string;
  /** 超时时间 */
  timeout?: number;
  /** 域名 */
  domain?: string;
  /** 全局错误处理函数 */
  onError?: (error: BizErrInfo) => void;
  /**
   * @description 自定义响应数据处理函数,将响应数据转换为 HomingResponse 类型
   * @param {any} data 响应数据
   * @returns {HomingResponse} 处理后的响应数据
   */
  transformResponseData?: (data: any) => HomingResponse;
}

// 鸿冥接收的响应体格式,必须一致
interface HomingResponse {
  code: number; // 0 为成功
  msg: string;
  success: boolean;// true 为成功
  data: any;
}

const homingClient = new HomingClient({
  appCode: '89530',
  appType: 'wecom',
  domain: '',
  onError: (error: any) => {
    console.log(error);
  },
  transformResponseData:(data:any)=>{
      return {...};
  }
});

基于 MIT 许可证发布