Package Exports

file-slice-upload
file-slice-upload/es/index.js
file-slice-upload/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (file-slice-upload) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

📄 File-Slice-Upload

Chinese

Quick Start

Install

Use npm install

npm install file-slice-upload

Use yarn install

yarn add file-slice-upload

Use file-slice-upload upload file's chunk

import fileUpload from 'file-slice-upload'
fileUpload()
.file(youFile, '1MB')
.uploadFunc(async(chunk)=>{
  const success = await postChunkFile(chunk)
  return success   /* return true will upload next chunk */
})
.start()

demo

live-demo

Feature

Easy to control the upload flow, help you focus on upload file logic !
Friendly api .start() .stop() .continue()...
More event start finish stop progress error...
Tiny
Use Typescript code

API document

export default

factory function，return the fileUpload instance

param	type	require	description
parallel	number - [1, 8]	false	every time send `n` file's chunks

fileUpload-class

fileUpload.file(file, chunkSize, chunkName?) => this

param	type	require	description
file	File	true	the file's chunk
chunkSize	String	true	chunk's size, for example: `'200KB'` `'1MB'` `'2M'`
chunkName	(file: File, index: number) => string	false	return this chunk file's name

fileUpload.uploadFunc(ajax) => this

param	type	require	description
ajax	(chunk: File \| File[], index: number, chunks: File[] \| File[][]) => Promise<any \| true>	true	upload chunk function , return true will upload next chunk

fileUpload.start() => this start upload
fileUpload.stop() => this suspend upload
fileUpload.continue() => this continue upload
fileUpload.on(eventName, cb) => this listen event
fileUpload.getFile() => file get file
fileUpload.getChunkSize() => number get chunk size

eventName	description	callback function type
start	start upload	`() => void`
finish	suspend upload	`(chunks: File[]) => void`
continue	continue upload	`() => void`
progress	upload progress	`({done: number, all: number}) => void`
chunk-uploaded	chunk uploaded	`({chunk: File, index: number, chunks: File[] }) => void`
error	upload fail	`() => void`

fileUpload.off(eventName, cb) => this close listen event