search

upyun / node-sdk

UPYUN SDK for JS(support browser and node.js)
96 stars 21 forks source link

readme

UPYUN JS SDK

NPM version Build Status dependencies Status

upyun js sdk, 支持服务端和客户端使用，集成：

安装

npm

$ npm install upyun --production --save

cdn

浏览器端手动安装时，需要手动引入 sdk 的依赖 axios （考虑到方便 axios 被复用，浏览器版本构建时，没有引入此依赖）

<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

再引入编译后的 sdk 文件

<script src="https://unpkg.com/upyun/dist/upyun.min.js"></script>

测试

$ npm run test

接口列表

所有的接口返回均是 Promise

Client

初始化

const client = new upyun.Client(service[, options][, getHeaderSignCallback])

参数

示例

const service = new upyun.Service('your service name', 'your operator name', 'your operator password')
const client = new upyun.Client(service);
/**
 * @param {!Service} service: Service 实例
 * @param {!string} method: 当前请求的 API 使用的方法
 * @param {!string} path: 当前请求的资源路径
 * @param {?string} contentMD5 内容的 md5 值
 */
function getSignHeader(service, method, path, contentMD5 = null) {
  // 请求自己的服务器，计算当前 api 请求签名信息
  // 可以参考该项目 sample 目录中的示例代码
  ...
}
const service = new upyun.Service('your service name')
const client = new upyun.Client(service, getSignHeader);

usage(path = '/')

查看目录大小（单位: byte）

参数

示例

client.usage('/sub/dir').then(function(size) {
  console.log('/sub/dir total used size: ' + size)
})

listDir(remotePath, options)

获取目录下文件列表

参数

响应

目录不存在，返回 false，否则返回一个对象，结构如下：

{
  files: [
    {
      name: 'example.txt', // file or dir name
      type: 'N', // file type, N: file; F: dir
      size: 28392812, // file size
      time: 1486053098 // last modify time
    }
  ],
  next: 'dlam9pd2Vmd2Z3Zg==' // next page iter
}

putFile(remotePath, localFile, options = {})

通过 rest api 上传文件

参数

响应

如果是非图片类文件，上传成功返回 true, 否则返回一个对象，包含图片的基本信息：

{
  width: 80,
  height: 80,
  'file-type': 'image/jpg',
  frames: 1
}

如果上传失败，返回 false

initMultipartUpload(remotePath, fileOrPath, options = {})

初始化一个并行式断点续传任务

参数

响应

初始化成功，返回一个对象：

{
  fileSize: 55997,
  partCount: 1,
  uuid: 'b2326f91-c5c4-4c6e-bce9-a41dae78ca2a'
}

如果初始化失败，返回 false

multipartUpload (remotePath, fileOrPath, multiUuid, partId)

参数

响应

数据传输成功返回 true, 反之返回 false

completeMultipartUpload (remotePath, multiUuid)

参数

响应

数据传输成功返回 true, 反之返回 false

makeDir(remotePath)

创建目录

参数

响应

创建成功返回 true，否则 false

headFile(remotePath)

HEAD 请求，获取文件基本信息

参数

响应

文件不存在返回 false。否则返回一个对象，结构如下，详见又拍云 HEAD

{
  'type': 'file', // 文件类型
  'size': 289239, // 文件大小
  'date': 1486053098, // 文件创建时间
  'Content-Md5': '9a56c9d185758d2eda3751e03b891fce'  // 文件 md5 值
}

deleteFile(remotePath)

删除文件或目录

参数

响应

删除成功返回 true, 否则返回 false

getFile(remotePath, saveStream = null)

下载保存在又拍云服务的文件

参数

响应

如果文件不存在，将会返回 false。文件存在时，若没有设置 saveStream，该方法 将直接返回文件内容。若设置了 saveStream，文件将直接写入该流，并返回流信息

示例

获取文件内容

client.getFile('/sample.txt').then(function (content) {
  console.log(content) // will out put file content directly
})

写入其他流

const saveTo = fs.createWriteStream('./localSample.txt')
client.getFile('/sample.txt', saveTo).then(function (stream) {
  // file has been saved to localSample.txt
  // you can pipe the stream to anywhere you want
})

formPutFile(remotePath, localFile, params = {}, opts = {})

使用又拍云表单 api 上传文件。客户端使用该方法时， 必须先设置获取又拍云 HTTP Body 签名的回调函数

参数

响应

成功返回一个对象，详细说明见异步通知规则参数说明部分，失败返回 false

copy(targetPath, sourcePath, options = {})

将文件 sourcePath 拷贝至 targetPath，不适用于文件夹。

参数

响应

操作成功返回 true, 反之返回 false

move(targetPath, sourcePath, options = {})

将文件 sourcePath 移动并重命名至 targetPath，不适用于文件夹。

参数

响应

操作成功返回 true, 反之返回 false

Service

又拍云服务，包含以下属性

sign

签名模块

备注

upyun npm package 曾为 James Chen 所有。

经过与其的交流协商，James 已经将此 npm 包转由 UPYUN 开发团队管理和维护。

后续的代码和版本更新，将于原有的项目无任何直接关系。

在 npm 上, "upyun": "<=0.0.3" 是由 James Chen 曾开发的 node-upyun 项目.

非常感谢 James Chen 对 upyun 的支持和贡献