{"id":18366167,"url":"https://github.com/AndersonPlus/Uploader","last_synced_at":"2025-08-26T11:31:55.503Z","repository":{"id":172468073,"uuid":"584305530","full_name":"AndersonPlus/Uploader","owner":"AndersonPlus","description":"TS Library","archived":false,"fork":false,"pushed_at":"2023-01-04T03:25:20.000Z","size":140,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-30T22:32:14.157Z","etag":null,"topics":["file-upload","library","object-oriented","typescript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/niuploader","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AndersonPlus.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-02T07:11:44.000Z","updated_at":"2023-03-16T06:38:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"9375473d-ac78-479e-a723-d0047ea00f61","html_url":"https://github.com/AndersonPlus/Uploader","commit_stats":null,"previous_names":["niyuancheng/uploader","nova-js/uploader","andersonplus/uploader"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/AndersonPlus/Uploader","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndersonPlus%2FUploader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndersonPlus%2FUploader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndersonPlus%2FUploader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndersonPlus%2FUploader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AndersonPlus","download_url":"https://codeload.github.com/AndersonPlus/Uploader/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndersonPlus%2FUploader/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272214419,"owners_count":24893201,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-26T02:00:07.904Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["file-upload","library","object-oriented","typescript"],"created_at":"2024-11-05T23:16:23.236Z","updated_at":"2025-08-26T11:31:55.497Z","avatar_url":"https://github.com/AndersonPlus.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NiUploader\n## 简介\n这是一款由TS开发的适用于大文件上传的库，参考```simple-uploader.js```和自己的理解进行了重构，依赖HTML5相关API，对IE9以下浏览器不支持，请选择合适版本的浏览器进行使用，感谢配合。\n本库已实现\n1. 大文件分片上传\n2. 文件断点续传\n3. 上传进度详细展示\n4. 上传取消和暂停\n5. 暂停后可以继续上传文件剩下部分\n#### npm地址： www.npmjs.com/package/niuploader\n#### github源码: https://github.com/niyuancheng/Uploader\n### 我的个人github主页： https://github.com/niyuancheng\n\n## 使用示例\n``` js\nimport Uploader from \"niuploader\"\n\nlet uploader = new Uploader({\n    chunkApi:\"http://localhost/test\",\n    fileApi:\"http://localhost/test\",\n    target: \"#file\",\n    ifSendByChunk: true,\n    chunkSize:1024,\n    autoUpload: true\n})\n\nuploader.addEventListener(\"fileSuccess\",(file)=\u003e{\n    console.log(\"所有文件发送成功\");\n})\n\nuploader.addEventListener(\"filePercent\",(speed,percent,expect)=\u003e{\n    console.log('-------------------------------');\n    console.log(`传输速度为: ${speed} B/s`);\n    console.log(`传输的比例为: ${percent}%`);\n    console.log(`预计还需${expect}s`);\n    console.log('-------------------------------');})\n```\n\n## 相关API\n1. __Uploader配置项__\n    - chunkApi: 必选参数，用于将大文件的每个切片发送给chunkApi参数的对应后端API接口，参数类型：string\n\n    - fileApi:必选参数，在所有分片都发送完毕后，uploader会给fileApi参数对应的后端接口发送ajax请求，通知后端该文件的所有分片已经传输完毕，可以进行分片整合获得完整的大文件；参数类型：string\n\n    - target：可选参数，传入target之后uploader会托管对应的DOM元素，__注意：target对应的托管元素必须为__```\u003cinput type=\"file\" /\u003e```否则会报错，参数类型: string类型的id或者className，或者直接传入对应的DOM元素：HTMLInputElement。\n\n    - workerPath: 可选参数，用于在工作者线程中加载指定的脚本来生成file和chunk的id,推荐使用本库自带的JS脚本hash_worker.js,可根据自己的情况修改路径，__但是一定要引入hash_worker.js，否则将无法正常生成ID!!!__\n    __建议：如果是在vue+webpack项目中使用可以将本库中的hash_worker.js放在public目录下，这样该文件就不会经过webpakc打包处理接着可以按如下的方式配置workerPath,经测试可完美正常使用__\n    ```js\n    workerPath: \"/hash_worker.js\"\n    ```\n    - ifSendByChunk: 可选参数，表示是否要对文件进行分片传输，默认为true。\n\n    - chunkSize: 可选参数，表示每一个分片的大小，默认为1024B\n\n    - autoUpload：可选参数，表示是否自动上传文件，默认为true\n\n2. __事件监听__\n\n    ```js\n    uploader.addEvenListener(event,(...args)=\u003e{\n        //ToDo\n    })\n    ```\n\n    1. fileProgress--文件上传过程中不断触发\n        fileItem -- 对应分片所属的具体文件信息\n        fileItem.id -- 文件的ID值\n        fileItem.size -- 文件的大小\n        fileItem.file -- 传输的文件对象\n    ```js\n    uploader.addEvenListener(\"fileProgress\",(fileItem,uploadedSize,totalSize)=\u003e{\n        //ToDo\n    })\n    ```\n\n    2.  fileAbort--文件上传取消或者暂停时触发\n    ```js\n    uploader.addEvenListener(\"fileAbort\",(fileItem)=\u003e{\n       \n    })\n    ```\n\n    3. fileError -- 文件上传错误触发\n\n    4. fileSuccess -- 文件上传成功触发\n\n    5. fileComplete -- 文件的上传过程结束时触发，可能为abort,erro或者success\n\n    6. filePercent -- __根据fileProgress单独封装出的进度事件，可以帮助使用者在视图层中具体显示文件的上传进度,上传时间，预计上传时间等有效信息__\n    ```js\n    uploader.addEvenListener(\"filePercent\",(speed, percent, expect) =\u003e {\n        console.log('-------------------------------');\n        console.log(`传输速度为: ${speed} B/s`);\n        console.log(`传输的比例为: ${percent}%`);\n        console.log(`预计还需${expect}s`);\n        console.log('-------------------------------');\n    })\n    ```\n\n    7.  chunkSend -- 某一分片开始上传时触发\n        chunkItem -- 对应分片的信息\n        chunkItem.id -- 分片的ID值\n        chunkItem.chunk -- 分片的二进制流信息\n        chunkItem.precent -- 分片的上传进度\n        chunkItem.size -- 分片的大小\n        \n    ```js\n    upoloader.addEventListener(\"chunkSend\",(fileItem,chunkItem) =\u003e {\n\n    })\n    ```\n\n    8. chunkProgress --某个分片在上传过程中不断触发\n\n    9. chunkSuccess -- 同fileSuccess\n    10. chunkAbort -- 同fileAbort\n    11. chunkError -- 同fileError\n    12. chunkComplete -- 同chunkComplete\n3. 实例方法\n    1. assign:如果用户不传入target，之后可以自行调用assign让uploader去托管指定的元素，传入参数类型与target配置项相同\n    ```js\n    uploader.assign(target)\n    ```\n    2. clearChunkStorage:清除本地存储的已经上传的文件的分片信息\n    ```js\n    uploader.clearChunkStorage()\n    ```\n    3. uploadFile:如果设置autoUpload为false的话，用户可以自行调用uploadFile上传文件\n    ```js\n    let fileInput = document.getElemenetById(\"file\");\n    fileInput.addEventListener(\"change\",(e) =\u003e {\n        let files = e.target.files;\n        for(let file of [...files]) {\n            uploader.uploadFile(file);\n        }\n    })\n    ```\n\n    4.cancelUploadFile:暂停文件的上传，此时uploader会abort所有还在上传中的切片，暂停后继续上传的话则只会上传未成功上传的切片，做到了断点上传（暂停后继续上传的话需要手动调用uploadFile方法）\n    ```js\n    uploader.addEventListener(\"chunkSuccess\",(fileItem,chunkItem,response)=\u003e{\n        uploader.cancelUploadFile(fileItem.file);\n    })\n\n    //继续上传\n    function continueUpload(file: File) {\n        uploader.uploadFile(file)\n    }\n    ```\n    \n    5.formatSize ：用于在进度事件中格式化字节大小\n    ```js\n    let size = 1024; //1024B\n    console.log(uploader.formatSize(size)) // 1KB\n    ```\n    ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAndersonPlus%2FUploader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAndersonPlus%2FUploader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAndersonPlus%2FUploader/lists"}