@jctrans-materials/shared 1.0.35-beta.0 → 1.0.36-beta.0

package/dist/index.d.ts

@@ -58,6 +58,11 @@ declare interface CarrierRequestPayload {
     [key: string]: any;
 }
 
+/**
+ * 检查账号是否存在(忘记密码专用)
+ * @param data
+ * @returns
+ */
 export declare function checkAccountExistsFPApi(data: any): Promise<any>;
 
 /**
@@ -148,12 +153,27 @@ export declare const ExpiresInKey = "JC-Expires-In";
 
 export declare const ExpiresInTimeKey = "JC-Expires-Time-In";
 
+/**
+ * 获取字典列表
+ * @param data
+ * @returns
+ */
 export declare function findDictAPi(data?: {
     size: number;
 }): Promise<any>;
 
+/**
+ * 根据手机邮箱获取重复列表
+ * @param data
+ * @returns
+ */
 export declare function findListByMobileEmailApi(data: any): Promise<any>;
 
+/**
+ * 查询区号列表
+ * @param data
+ * @returns
+ */
 export declare function findPAreaCodeAPi(data?: {
     size: number;
 }): Promise<any>;
@@ -255,8 +275,10 @@ export declare function getJoinCompanyApi(data: any): Promise<any>;
  */
 export declare function getLanguage(): string | undefined;
 
-/***
+/**
  * 获取本地 IP 数据
+ * @param data
+ * @returns
  */
 export declare function getLocalIpDataApi(data: any): Promise<any>;
 
@@ -346,6 +368,11 @@ export declare const getSharedConfig: () => {
  */
 export declare function getToken(): string | undefined;
 
+/**
+ * 获取用户手机号邮箱信息
+ * @param data
+ * @returns
+ */
 export declare function getUserInfoApi(data: any): Promise<any>;
 
 export declare const HasLoginKey = "hasLogin";
@@ -629,6 +656,11 @@ export declare interface LocationUnifiedItem {
     raw?: any;
 }
 
+/**
+ * 用户登录
+ * @param loginData
+ * @returns
+ */
 export declare function loginApi(loginData: LoginDataParams): Promise<IResponse<ApiResponse<LoginResponseData>>>;
 
 /**
@@ -638,8 +670,18 @@ export declare function loginApi(loginData: LoginDataParams): Promise<IResponse<
  */
 export declare function loginByEmailOrMobileCodeApi(data: any): Promise<IResponse<ApiResponse<LoginResponseData>>>;
 
+/**
+ * Facebook 登录
+ * @param data
+ * @returns
+ */
 export declare function loginByFacebookApi(data: any): Promise<IResponse<ApiResponse<ThirdResponseData>>>;
 
+/**
+ * LinkedIn 登录
+ * @param data
+ * @returns
+ */
 export declare function loginByLinkedinApi(data: any): Promise<IResponse<ApiResponse<ThirdResponseData>>>;
 
 /**
@@ -730,6 +772,11 @@ export declare const RefreshTokenKey = "JC-Refresh-Token";
  */
 export declare function registerApi(data: any): Promise<any>;
 
+/**
+ * 使用第三方应用注册用户公司
+ * @param data
+ * @returns
+ */
 export declare function registerByThirdPartyApi(data: any): Promise<any>;
 
 /**
@@ -798,6 +845,11 @@ declare interface RequestOptions {
  */
 export declare function resetAuthSessionItems(): void;
 
+/**
+ * 重置密码
+ * @param data
+ * @returns
+ */
 export declare function resetPasswordApi(data: any): Promise<any>;
 
 /**
@@ -934,11 +986,21 @@ export declare interface SharedConfig {
     appId?: string;
 }
 
+/**
+ * 滑动或者点选验证
+ * @param data
+ * @returns
+ */
 export declare function slideCheckApi(data: {
     pointJson: string;
     uuid: string;
 }): Promise<any>;
 
+/**
+ * 获取验证图片  以及token
+ * @param data
+ * @returns
+ */
 export declare function slideGetApi(data: {
     clientUid: string;
     ts: number;