Docs: 文档更新

pandaoh · Nov 4, 2024 · 33fa218 · 33fa218
1 parent 3f38120
commit 33fa218
Show file tree

Hide file tree

Showing 11 changed files with 157 additions and 157 deletions.
diff --git a/dist/File/index.d.ts b/dist/File/index.d.ts
@@ -8,7 +8,7 @@
  * getFileType('document'); // 'unknown'
  * @param str 字符串（URL 、路径或文件名）。
  * @returns 文件类型（小写格式）
- * @category Tools-下载/文件相关
+ * @category File-文件相关
  */
 export declare function getFileType(str: string): string;
 /**
@@ -27,7 +27,7 @@ export declare function getFileType(str: string): string;
  * @param str 字符串（URL 、路径或文件名）。
  * @param keepExt 可选。如果为 true，则返回包含文件扩展名的完整文件名，若无扩展名则使用 `.unknown`。
  * @returns 文件名（带或不带扩展名）
- * @category Tools-下载/文件相关
+ * @category File-文件相关
  */
 export declare function getFileNameFromStr(str: string, keepExt?: boolean): string;
 /**
@@ -38,7 +38,7 @@ export declare function getFileNameFromStr(str: string, keepExt?: boolean): stri
  * checkFileExt(['png', 'jpg'], 'test.jpg.txt'); /// false
  * @param value 字符串值
  * @returns
- * @category String-字符串
+ * @category File-文件相关
  */
 export declare function checkFileExt(arr: string[], value: string): boolean;
 /**
@@ -49,7 +49,7 @@ export declare function checkFileExt(arr: string[], value: string): boolean;
  * openFileSelect({ multiple: true, accept: '.txt', resultType: 'base64' }).then(fileDataUrlList => console.log(fileDataUrlList));
  * @param options 打开配置
  * @returns
- * @category Tools-下载/文件相关
+ * @category File-文件相关
  */
 export declare function openFileSelect(options?: {
     accept?: string;
@@ -66,7 +66,7 @@ export declare function openFileSelect(options?: {
  * @param blob 要保存的 Blob 对象。
  * @param filename 可选。保存的文件名。
  * @returns
- * @category Tools-下载/文件相关
+ * @category File-文件相关
  */
 export declare function saveAs(blob: Blob, filename?: string): void;
 /**
@@ -83,7 +83,7 @@ export declare function saveAs(blob: Blob, filename?: string): void;
  * @param url 图片的 URL 地址。
  * @param fileName 可选。下载的文件名。
  * @returns
- * @category Tools-下载/文件相关
+ * @category File-文件相关
  */
 export declare function downloadImg(url: string, fileName?: string): void;
 /**
@@ -100,7 +100,7 @@ export declare function downloadImg(url: string, fileName?: string): void;
  * @param url 文件的 URL 地址。
  * @param fileName 可选。下载的文件名，默认为 URL 中的文件名。
  * @returns
- * @category Tools-下载/文件相关
+ * @category File-文件相关
  */
 export declare function downloadFile(url: string, fileName?: string): void;
 /**
@@ -118,7 +118,7 @@ export declare function downloadFile(url: string, fileName?: string): void;
  * openPreviewFile('https://example.com/path/to/otherfile.zip'); // 将直接打开链接
  * @param url 要预览的 URL 地址。
  * @returns
- * @category Tools-下载/文件相关
+ * @category File-文件相关
  */
 export declare function openPreviewFile(url: string, serviceUrl: string): void;
 /**
@@ -130,7 +130,7 @@ export declare function openPreviewFile(url: string, serviceUrl: string): void;
  * @param contentType 内容类型
  * @param callBack 回调函数
  * @returns
- * @category Tools-下载/文件相关
+ * @category File-文件相关
  */
 export declare function transferFileToBase64(content: any, contentType: string, callBack: any): void;
 /**
@@ -140,7 +140,7 @@ export declare function transferFileToBase64(content: any, contentType: string,
  * @param link 链接
  * @param name 文件名称(可选，默认以链接最好一段作为名称，填写时可不带后缀自动识别，写了后缀会以写的后缀为准。)
  * @returns
- * @category Tools-下载/文件相关
+ * @category File-文件相关
  */
 export declare function download(link: string, name: string): void;
 /**
@@ -151,7 +151,7 @@ export declare function download(link: string, name: string): void;
  * @param name 文件名称(需带后缀)，默认 txt 。
  * @param content 内容 BlobPart | any
  * @returns
- * @category Tools-下载/文件相关
+ * @category File-文件相关
  */
 export declare function downloadContent(name: string, content: any): void;
 /**
@@ -162,7 +162,7 @@ export declare function downloadContent(name: string, content: any): void;
  * @param fields 导出的栏位
  * @param data 数据
  * @returns
- * @category Tools-下载/文件相关
+ * @category File-文件相关
  */
 export declare function transferCSVData(fields: {
     label?: string;
@@ -179,7 +179,7 @@ export declare function transferCSVData(fields: {
  * @param fileName 文件名
  * @param fileType 文件类型
  * @returns
- * @category Tools-下载/文件相关
+ * @category File-文件相关
  */
 export declare function exportFile(data: string, fileName?: string, fileType?: string): void;
 /**
@@ -189,7 +189,7 @@ export declare function exportFile(data: string, fileName?: string, fileType?: s
  * @param bytes 文件大小 bytes
  * @param precision 精度
  * @returns
- * @category Others-业务/其他
+ * @category File-文件相关
  */
 export declare function formatBytes(bytes: number, precision?: number): string;
 //# sourceMappingURL=index.d.ts.map
diff --git a/dist/index.source.js b/dist/index.source.js
@@ -15614,7 +15614,7 @@
    * getFileType('document'); // 'unknown'
    * @param str 字符串（URL 、路径或文件名）。
    * @returns 文件类型（小写格式）
-   * @category Tools-下载/文件相关
+   * @category File-文件相关
    */
   function getFileType(str) {
       var _a, _b;
@@ -15636,7 +15636,7 @@
    * @param str 字符串（URL 、路径或文件名）。
    * @param keepExt 可选。如果为 true，则返回包含文件扩展名的完整文件名，若无扩展名则使用 `.unknown`。
    * @returns 文件名（带或不带扩展名）
-   * @category Tools-下载/文件相关
+   * @category File-文件相关
    */
   function getFileNameFromStr(str, keepExt) {
       var _a;
@@ -15655,7 +15655,7 @@
    * checkFileExt(['png', 'jpg'], 'test.jpg.txt'); /// false
    * @param value 字符串值
    * @returns
-   * @category String-字符串
+   * @category File-文件相关
    */
   function checkFileExt(arr, value) {
       var regFileExt = arr.map(function (name) { return ".".concat(name); }).join('|');
@@ -15669,7 +15669,7 @@
    * openFileSelect({ multiple: true, accept: '.txt', resultType: 'base64' }).then(fileDataUrlList => console.log(fileDataUrlList));
    * @param options 打开配置
    * @returns
-   * @category Tools-下载/文件相关
+   * @category File-文件相关
    */
   function openFileSelect(options) {
       var _this = this;
@@ -15778,7 +15778,7 @@
    * @param blob 要保存的 Blob 对象。
    * @param filename 可选。保存的文件名。
    * @returns
-   * @category Tools-下载/文件相关
+   * @category File-文件相关
    */
   function saveAs(blob, filename) {
       var url = window.URL || window.webkitURL;
@@ -15804,7 +15804,7 @@
    * @param url 图片的 URL 地址。
    * @param fileName 可选。下载的文件名。
    * @returns
-   * @category Tools-下载/文件相关
+   * @category File-文件相关
    */
   function downloadImg(url, fileName) {
       if (!url || !url.startsWith('http')) {
@@ -15853,7 +15853,7 @@
    * @param url 文件的 URL 地址。
    * @param fileName 可选。下载的文件名，默认为 URL 中的文件名。
    * @returns
-   * @category Tools-下载/文件相关
+   * @category File-文件相关
    */
   function downloadFile(url, fileName) {
       var _a, _b, _c;
@@ -15884,7 +15884,7 @@
    * openPreviewFile('https://example.com/path/to/otherfile.zip'); // 将直接打开链接
    * @param url 要预览的 URL 地址。
    * @returns
-   * @category Tools-下载/文件相关
+   * @category File-文件相关
    */
   function openPreviewFile(url, serviceUrl) {
       var urlMap = new Map()
@@ -15919,7 +15919,7 @@
    * @param contentType 内容类型
    * @param callBack 回调函数
    * @returns
-   * @category Tools-下载/文件相关
+   * @category File-文件相关
    */
   function transferFileToBase64(content, contentType, callBack) {
       var blob = new Blob([content], {
@@ -15942,7 +15942,7 @@
    * @param link 链接
    * @param name 文件名称(可选，默认以链接最好一段作为名称，填写时可不带后缀自动识别，写了后缀会以写的后缀为准。)
    * @returns
-   * @category Tools-下载/文件相关
+   * @category File-文件相关
    */
   function download(link, name) {
       if (!name) {
@@ -15964,7 +15964,7 @@
    * @param name 文件名称(需带后缀)，默认 txt 。
    * @param content 内容 BlobPart | any
    * @returns
-   * @category Tools-下载/文件相关
+   * @category File-文件相关
    */
   function downloadContent(name, content) {
       if (!name) {
@@ -15992,7 +15992,7 @@
    * @param fields 导出的栏位
    * @param data 数据
    * @returns
-   * @category Tools-下载/文件相关
+   * @category File-文件相关
    */
   function transferCSVData(fields, data) {
       var _a;
@@ -16019,7 +16019,7 @@
    * @param fileName 文件名
    * @param fileType 文件类型
    * @returns
-   * @category Tools-下载/文件相关
+   * @category File-文件相关
    */
   function exportFile(data, fileName, fileType) {
       if (fileType === void 0) { fileType = 'txt'; }
@@ -16043,7 +16043,7 @@
    * @param bytes 文件大小 bytes
    * @param precision 精度
    * @returns
-   * @category Others-业务/其他
+   * @category File-文件相关
    */
   function formatBytes(bytes, precision) {
       var _a;

diff --git a/docs/README.md b/docs/README.md
@@ -93,6 +93,23 @@
 - [logRunTime](functions/logRunTime.md)
 - [showVar](functions/showVar.md)
 
+## File-文件相关
+
+- [checkFileExt](functions/checkFileExt.md)
+- [download](functions/download.md)
+- [downloadContent](functions/downloadContent.md)
+- [downloadFile](functions/downloadFile.md)
+- [downloadImg](functions/downloadImg.md)
+- [exportFile](functions/exportFile.md)
+- [formatBytes](functions/formatBytes.md)
+- [getFileNameFromStr](functions/getFileNameFromStr.md)
+- [getFileType](functions/getFileType.md)
+- [openFileSelect](functions/openFileSelect.md)
+- [openPreviewFile](functions/openPreviewFile.md)
+- [saveAs](functions/saveAs.md)
+- [transferCSVData](functions/transferCSVData.md)
+- [transferFileToBase64](functions/transferFileToBase64.md)
+
 ## Form-表单相关
 
 - [formDataToObject](functions/formDataToObject.md)
@@ -181,7 +198,6 @@
 - [calcCron](functions/calcCron.md)
 - [checkVersion](functions/checkVersion.md)
 - [compareTo](functions/compareTo.md)
-- [formatBytes](functions/formatBytes.md)
 - [formatRh](functions/formatRh.md)
 - [getBloodGroup](functions/getBloodGroup.md)
 - [getDataStr](functions/getDataStr.md)
@@ -252,7 +268,6 @@
 ## String-字符串
 
 - [addSpace](functions/addSpace.md)
-- [checkFileExt](functions/checkFileExt.md)
 - [checkPassWordLevel](functions/checkPassWordLevel.md)
 - [getPinYin](functions/getPinYin.md)
 - [hasSpecialChar](functions/hasSpecialChar.md)
@@ -299,21 +314,6 @@
 - [hideToast](functions/hideToast.md)
 - [showToast](functions/showToast.md)
 
-## Tools-下载/文件相关
-
-- [download](functions/download.md)
-- [downloadContent](functions/downloadContent.md)
-- [downloadFile](functions/downloadFile.md)
-- [downloadImg](functions/downloadImg.md)
-- [exportFile](functions/exportFile.md)
-- [getFileNameFromStr](functions/getFileNameFromStr.md)
-- [getFileType](functions/getFileType.md)
-- [openFileSelect](functions/openFileSelect.md)
-- [openPreviewFile](functions/openPreviewFile.md)
-- [saveAs](functions/saveAs.md)
-- [transferCSVData](functions/transferCSVData.md)
-- [transferFileToBase64](functions/transferFileToBase64.md)
-
 ## Tools-事件相关
 
 - [disableConflictEvent](functions/disableConflictEvent.md)