Skip to content

快速开始

安装

bash
# npm
npm install @file-ud.js/core

# pnpm
pnpm add @file-ud.js/core

# yarn
yarn add @file-ud.js/core

# bun
bun add @file-ud.js/core

官方插件包按需安装:

bash
# npm
npm install @file-ud.js/plugins

# pnpm
pnpm add @file-ud.js/plugins

# yarn
yarn add @file-ud.js/plugins

# bun
bun add @file-ud.js/plugins

实例模式选择

new Uploader(config) / new Downloader(config) 是单例模式,适合页面里只有一个全局上传器或下载器的简单场景。

实际业务中更推荐使用 FileUD.createUploader(name, config) / FileUD.createDownloader(name, config)。它们是命名多实例模式,可以按 name 隔离不同业务入口;同名重复创建时,会销毁旧实例再创建新实例。

基本使用

Uploader 上传

typescript
import { FileUD } from "@file-ud.js/core";

// 创建上传器
const uploader = FileUD.createUploader("myUploader", {
  action: "/api/upload",
  multiple: true,
  autoUpload: true,
});

// 监听上传成功
uploader.onSuccess = (response, file) => {
  console.log("上传成功:", response);
};

// 打开文件选择器
uploader.open();

Downloader 下载

typescript
import { FileUD } from "@file-ud.js/core";

// 创建下载器
const downloader = FileUD.createDownloader("myDownloader", {
  action: "https://example.com/file.pdf",
});

// 监听下载完成
downloader.onSuccess = (response, file) => {
  console.log("下载完成:", file.fileName);
};

// 添加下载任务
downloader.downloadFile({
  url: "https://example.com/file.pdf",
  fileName: "document.pdf",
});

下一步

基于 MIT 协议发布