Skip to content

lisposter/co-upyun

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

co-upyun

NPM version Build status Test coverage

DEPRECATED, please use this instead.
DEPRECATED, please use this instead.
DEPRECATED, please use this instead.

An upyun sdk for node.js, which is for co-like interface. Can be used with koa or co.

Install

$ npm install co-upyun

Example

var co = require('co');
co(function *() {
    var res = yield upyun.getUsage();
    console.log(res);
})();

You should always use these methods in your generator function. It works perfectly in TJ's co.

Usage

init a UPYUN instance.

var upyun = new UPYUN('bucket', 'username', 'password', 'endpoint');
  • bucket: Your upyun bucket name.
  • username: Your upyun operator name.
  • password: Your upyun operator password.
  • endpoint: api address. It can be ctcc, cucc, cmcc. If you don't specify a endpoint, SDK will choose a fastest api automatically.
    • ctcc China Telecom
    • cucc China Unicom
    • cmcc China Mobile

Docs

API

Utils

API

### getUsage() To get how many quota has been used.(Unit:`Byte`)
### listDir(remote_dir_path) Get the file list of that dir. The response contains each item's type(file or dir), size(unit: `Byte`), last modify time.

Arguments

  • remote_dir_path The dir path which you want to traverse.

### createDir(remote_dir_path, make_dir) Create a new dir in UPYUN bucket.

Arguments

  • remote_dir_path The dir path which you want to create.
  • make_dir Auto create parent dir if it isn't exists.(Default: true).

### removeDir(remote_dir_path) Delete a dir
  • remote_dir_path The dir path which you want to remove.

### uploadFile(remote_path, file, make_dir, checksum, opts) Upload a file into UPYUN bucket.

Arguments


### getFileInfo(remote_path) Get the file info. The response contains the file type(file or dir), size, create time.

Arguments

  • remote_path The file's path in your UPYUN bucket.

### downloadFile(remote_path) Download a file from UPYUN bucket.

Arguments

  • remote_path The file's path in your UPYUN bucket.

### removeFile(remote_path) Delete a file from UPYUN bucket.

Arguments

  • remote_path The file's path in your UPYUN bucket.

Utils

### setEndpoint(endpoint) Use this method to set api endpoint manually.

Arguments

  • endpoint The value can be these(leave blank to let sdk auto select the best one):
    • ctcc China Telecom
    • cucc China Unicom
    • cmcc China Mobile

Response

For easy to use, all of the apis will return a response in this format: eg.

{
    statusCode: 200,
    data: {},
    headers: {},
    error: {
      code: 403,
      message: 'Not a valid image file'
    }
}

中文文档,请查看 WIKI.

About

A upyun sdk for node.js, which is for co-like interface. Can be used with koa or co.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published