tus-js-client 使用教程

本教程将指导您了解并使用 tus-js-client 这一纯 JavaScript 客户端库，它支持 tus 协议进行可断点续传的文件上传。

1. 项目目录结构及介绍

在您克隆或下载 tus-js-client 仓库后，目录结构大致如下：

tus-js-client/
├── src/            # 源代码目录
│   ├── tus.js      # 主要的客户端实现
│   └── ...          # 其他辅助模块
├── dist/           # 构建输出目录（预编译的 UMD 和 ES 模块）
├── package.json    # 项目元数据，包括依赖、脚本等
└── README.md       # 项目说明文档

src/ 目录包含了库的核心代码，其中 tus.js 是主要的客户端文件。dist/ 目录则包含构建好的可用于浏览器和 Node.js 环境的打包文件。

2. 项目的启动文件介绍

tus-js-client 不包含一个传统的“启动”文件，因为它是一个库，而非一个独立的应用程序。然而，开发者通常会在自己的应用程序中引入该库以初始化文件上传流程。例如，在一个浏览器环境中，您可以这样使用：

// 引入 tus-js-client
import Tus from 'tus-js-client';

// 初始化上传
let upload = new Tus.Upload(file, {
  endpoint: 'http://localhost:1080/files/',
  retryDelays: [0, 3000, 5000, 10000, 20000],
  metadata: {
    filename: file.name,
    filetype: file.type
  },
  onError: function(error) {
    console.log('Failed because: ' + error);
  }
});

这个示例展示了如何创建一个新的 tus 上传实例，并指定了服务器端点和其他参数。

3. 项目的配置文件介绍

tus-js-client 的配置主要是在初始化 Tus.Upload 对象时通过参数传递的。以下是一些关键选项：

• endpoint: 服务器接收上传文件的 URL。
• retryDelays: 数组，表示在遇到错误时延迟多少毫秒再重试。
• metadata: 一个对象，包含了关于上传文件的元数据，如名称和类型。
• onError: 遇到错误时执行的回调函数。

除了这些，还有其他高级配置选项，如 onProgress, onChunkComplete, uploadUrl 等，可以在项目文档中找到详细信息。

请注意，tus-js-client 本身没有配置文件，因为它是作为一个库被集成到您的项目中的。如果您想要自定义默认配置，可能需要在您的应用程序级别创建一个配置对象，并在每次创建上传实例时应用该配置。

了解更多细节，可以查阅项目官方文档以及 README.md 文件。祝您使用愉快！