utils.d.ts 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. import { IWordsData, IFilterType } from './props';
  2. /**
  3. * json转字符串
  4. * @param {string} data 需要转json的字符串
  5. * @return {object} json 字符串
  6. */
  7. export declare function safeJSONparse(data: string): object;
  8. /**
  9. * 判断数组是否为空
  10. */
  11. export declare function isWordsDataEmpty(arr: any): boolean;
  12. /**
  13. * 清除字符串里的数字
  14. */
  15. export declare function clearNumberInStr(str: string): string;
  16. /**
  17. * 格式化字库数据
  18. * @param datas ZDatas 数据
  19. * @return {IWordsData} 字库
  20. */
  21. export declare function formatZDatas(datas?: any[]): any[];
  22. /**
  23. * 候选字推荐序函数
  24. * 考虑两个维度,一个是输入值和生僻字的匹配程度,比如你输入YA 雅是完全匹配,炎是模糊匹配,排列的时候肯定”雅“在前面,
  25. * 如果除了”雅“还有一个”亚“,两个都是完全匹配,这个时候就看哪个字占比高,哪个就排在前面
  26. * @param {IWordsData} wordsData 字库数据
  27. * @param {string} inputValue 当前输入的值
  28. * @param {string} filterKey 过滤依据的key值
  29. * @return {IWordsData} 返回符合要求并且排序好的候选项列表
  30. */
  31. export declare function matchWordsRecommend(wordsData?: IWordsData, inputValue?: string, filterKey?: IFilterType): IWordsData;
  32. /**
  33. * 字库过滤,只挑选符合要求的候选字
  34. * @param {IWordsData} wordsData 字库数据
  35. * @param {string} inputValue 当前输入的值
  36. * @param {string} filterKey 过滤依据的key值
  37. * @return {IWordsData} 返回符合要求并且排序好的候选项列表
  38. */
  39. export declare function wordsFilter(wordsData?: IWordsData, inputValue?: string, filterKey?: IFilterType): IWordsData;
  40. /**
  41. * 候选项排序,用户选择可能性高的候选项排在前面
  42. * @param {IWordsData} wordsData 字库数据
  43. * @param {string} inputValue 当前输入的值
  44. * @param {string} filterKey 过滤依据的key值
  45. * @return {IWordsData} 返回符合要求并且排序好的候选项列表
  46. */
  47. export declare function wordsSorter(wordsData: IWordsData, inputValue: string, filterKey?: IFilterType): IWordsData;
  48. /**
  49. * 加载远程字体
  50. */
  51. export declare function loadFontFace(): Promise<void>;