feat(utils): 完善 downloadFile

.dumirc.ts

@@ -9,6 +9,7 @@ export default defineConfig({
       { title: 'Hooks', link: '/hooks/useClickAway' },
       { title: '转换', link: '/formats/addThousandSeparator' },
       { title: '校验', link: '/validators/isAsyncFunction' },
+      { title: '工具', link: '/utils/downloadFile' },
     ],
     footer: `Copyright © ${new Date().getFullYear()} nmsn`,
     logo: '/logo.png',
@@ -20,6 +21,7 @@ export default defineConfig({
       { type: 'hooks', dir: '/src/hooks' },
       { type: 'format', dir: 'src/format' },
       { type: 'validator', dir: 'src/validator' },
+      { type: 'utils', dir: 'src/utils' },
     ],
     codeBlockMode: 'passive',
     forceKebabCaseRouting: false,

src/index.ts

@@ -2,4 +2,5 @@ export * from './format';
 export * from './hooks';
 export * from './regex';
 export * from './types';
+export * from './utils';
 export * from './validator';

src/utils/downloadFile/demo.tsx

@@ -0,0 +1,14 @@
+import React from 'react';
+
+import { downloadFile } from '@nmsn/utils';
+
+const url = 'https://s2.loli.net/2023/04/20/4t8NgpMxkdVCJcs.png';
+
+export default () => {
+  return (
+    <>
+      <img src={url} alt="logo" style={{ width: 200, height: 150 }} />
+      <button onClick={() => downloadFile(url)}>click</button>
+    </>
+  );
+};

src/utils/downloadFile/index.md

@@ -0,0 +1,23 @@
+---
+title: downloadFile
+toc: false
+---
+
+## downloadFile
+
+下载文件，避免浏览器默认行为，如图片pdf会被浏览器直接打开
+
+<code src="./demo.tsx"></code>
+
+### API
+
+```typescript
+downloadFile(url: string, name?: string);
+```
+
+### Params
+
+| 参数 | 说明 | 类型     | 默认值 |
+| ---- | ---- | -------- | ------ |
+| url  | 资源地址 | `string` | -      |
+| name | 覆盖的文件名 | `string` | -      |

src/utils/download/index.ts → src/utils/downloadFile/index.ts

@@ -1,5 +1,5 @@
 /** 下载文件 */
-const loadFile = (fileUrl: string, name?: string) => {
+const downloadFile = (fileUrl: string, name?: string) => {
   fetch(fileUrl)
     .then(res => res.blob())
     .then(blob => {
@@ -19,4 +19,4 @@ const loadFile = (fileUrl: string, name?: string) => {
     });
 };
 
-export default loadFile;
+export default downloadFile;

src/utils/index.ts

@@ -1 +1 @@
-export { default as download } from './download';
+export { default as downloadFile } from './downloadFile';