skipper-qiniu

A Skipper adapter for Qiniu.

Usage no npm install needed!

<script type="module">
  import skipperQiniu from 'https://cdn.skypack.dev/skipper-qiniu';
</script>

README

skipper emblem - face of a ship's captain Qiniu Storage Adapter

npm version

Qiniu adapter for receiving upstreams. Particularly useful for handling streaming multipart file uploads from the Skipper body parser.

Installation

$ npm install skipper-qiniu --save

Also make sure you have skipper itself installed as your body parser. This is the default configuration in Sails as of v0.10.

Usage

req.file('avatar').upload({
  adapter: require('skipper-qiniu'),
  bucket: 'development', // required
  accessKey: 'your qiniu accessKey', // required
  secretKey: 'your qiniu secretKey', // required
  policy: {
    // returnUrl should not be included
    returnBody: '{"name": $(fname),"size": $(fsize),"width": $(imageInfo.width),"height": $(imageInfo.height),"key": $(key)}'
  },
  extra: {}
}, function(err, files) {
  if (err) {
    return res.serverError(err);
  }

  return res.json({
    message: files.length + ' file(s) uploaded successfully!',
    files: files
  });
});

For more detailed usage information and a full list of available options, see Qiniu Node.js SDK.

Contributions

If you want to contribute something to the project, feel free to create a pull request or open an issue.

To run the tests:

git clone git@github.com:loulin/skipper-qiniu.git
cd skipper-qiniu
npm install
ACCESSKEY=your_qiniu_access_key SECRETKEY=your_qiniu_secret_key BUCKET=your_qiniu_bucket npm test

Please don't check in your qiniu credentials :)

License

MIT © 2015-

Lin Lou, Node.js & contributors

See LICENSE.md.

This module is part of the Sails framework, and is free and open-source under the MIT License.

image_squidhome@2x.png