Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

ufile-rest

0.0.1 • Public • Published

ufile-rest

ufile官方的node sdk实现比较悲惨……

接口参数和返回参考https://docs.ucloud.cn/api/ufile-api/index

UFile

Kind: global class

new UFile(pubKey, priKey, bucketName, domain, useHttps)

UFile SDK

Param Type Default Description
pubKey string api公钥
priKey string api私钥
bucketName string 存储空间名
domain string 存储空间域名
useHttps boolean false 是否使用https

uFile.prefixFileList([prefix], [marker], [limit]) ⇒ Promise

前缀列表查询

Kind: instance method of UFile

Param Type Default Description
[prefix] string "''" 前缀,utf-8编码,默认为空字符串
[marker] string "''" 标志字符串,utf-8编码,默认为空字符串
[limit] number 20 文件列表数目,默认为20

uFile.putFile(key, file, [mimeType]) ⇒ Promise

上传文件

Kind: instance method of UFile

Param Type Default Description
key string
file Buffer | Stream.Readable | string 文件
[mimeType] string "'application/octet-stream'" 文件类型

uFile.uploadHit(hash, fileName, fileSize) ⇒ Promise

秒传文件

Kind: instance method of UFile

Param Type Description
hash string 待上传文件的ETag,详见ETag生成文档
fileName string Bucket中文件的名称
fileSize string 待上传文件的大小

uFile.getFile(key, [range], [ifModifiedSince]) ⇒ Promise

下载文件

Kind: instance method of UFile

Param Type Description
key string key
[range] string 分片下载的文件范围
[ifModifiedSince] string 只返回从某时修改过的文件,否则返回304(not modified)

uFile.headFile(key) ⇒ Promise

查询文件基本信息

Kind: instance method of UFile

Param Type
key string

uFile.deleteFile(key) ⇒ Promise

删除文件

Kind: instance method of UFile

Param Type
key string

uFile.initiateMultipartUpload(key) ⇒ Promise

初始化分片上传

Kind: instance method of UFile

Param Type Description
key string 文件名

uFile.uploadPart(key, uploadId, partNumber, buffer) ⇒ Promise

上传分片

Kind: instance method of UFile

Param Type Description
key string 文件名
uploadId string 分片id
partNumber number 第几块分片
buffer buffer 内容

uFile.finishMultipartUpload(key, uploadId, [newKey], parts) ⇒ Promise

完成分片

Kind: instance method of UFile

Param Type Description
key string 文件名
uploadId string 分片id
[newKey] string 等上传完毕开始指定的key可能已经被占用,遇到这种情形时会采用newKey参数的值作为文件最终的key,否则仍然采用原来的key
parts array 分片的etag们

uFile.abortMultipartUpload(key, uploadId) ⇒ Promise

放弃分片

Kind: instance method of UFile

Param Type Description
key string 文件名
uploadId string 分片id

uFile.getMultiUploadId([prefix], [marker], [limit]) ⇒ Promise

获取正在执行的分片上传

Kind: instance method of UFile

Param Type Default Description
[prefix] string 前缀,utf-8编码,默认为空字符串
[marker] string 标志字符串,utf-8编码,默认为空字符串
[limit] number 20 id列表数目,默认为20

uFile.getMultiUploadPart(uploadId) ⇒ Promise

获取已上传成功的分片列表

Kind: instance method of UFile

Param Type Description
uploadId string 上传id

uFile.opMeta(key, mimeType) ⇒ Promise

操作文件的Meta信息

Kind: instance method of UFile

Param Type Description
key string key
mimeType string 文件的mimetype

Keywords

install

npm i ufile-rest

Downloadsweekly downloads

1

version

0.0.1

license

ISC

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar