https://github.com/yingye/gulp-upload-qcloud

腾讯云 cos 静态资源上传 gulp 插件
https://github.com/yingye/gulp-upload-qcloud

cdn cos gulp gulp-plugin nodejs qcloud

Last synced: 3 months ago
JSON representation

腾讯云 cos 静态资源上传 gulp 插件

• Host: GitHub
• URL: https://github.com/yingye/gulp-upload-qcloud
• Owner: yingye
• License: mit
• Created: 2017-07-29T08:11:12.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-07T09:17:16.000Z (about 2 years ago)
• Last Synced: 2024-04-24T18:55:47.420Z (9 months ago)
• Topics: cdn, cos, gulp, gulp-plugin, nodejs, qcloud
• Language: JavaScript
• Homepage:
• Size: 319 KB
• Stars: 17
• Watchers: 2
• Forks: 5
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gulp-upload-qcloud

腾讯云上传 gulp 插件

## Install

```

npm install --save-dev gulp-upload-qcloud

```

## Usage

```js

const gulp = require('gulp');

const uploadQcloud = require('gulp-upload-qcloud');

gulp.task('upload', () => {

  return gulp.src(['test/**/*.*'])

    .pipe(uploadQcloud({

      AppId: 'STRING_VALUE',

      SecretId: 'STRING_VALUE',

      SecretKey: 'STRING_VALUE',

      Bucket: 'STRING_VALUE',

      Region: 'STRING_VALUE',

      Prefix: 'demo/sub',

      Headers: {

        CacheControl: 'max-age=31536000'

      },

      OverWrite: false

    }));

});

```

## API

### uploadQcloud([options])

#### options

Type: Object

There are 7 options:

* `AppId`(string): 注册或登录 [腾讯云](https://cloud.tencent.com/login) 获取您的AppId。

* `SecretId`(string): 到 [腾讯云控制台密钥管理](https://console.cloud.tencent.com/capi) 获取您的项目 SecretId 和 SecretKey。

* `SecretKey`(string): 同 SecretId。

* `Bucket`(string): 到 [COS 对象存储控制台](https://console.cloud.tencent.com/cos4) 创建存储桶，得到 Bucket（存储桶名称） 和 Region（地域名称）。

* `Region`(string): Bucket 所在区域。枚举值请见：[Bucket 地域信息](https://cloud.tencent.com/document/product/436/6224)。

* `Prefix`(string): 自定义文件前缀，例如本地文件路径 img.png ，设置了 `Prefix: 'demo'`，最终腾讯云路径为 `demo/img.png`，默认为空。

* `Headers(object)`: 设置头信息，具体 API 参考[简单上传-参数说明](https://cloud.tencent.com/document/product/436/35649)。

* `OverWrite`(string): 是否覆盖同名文件，默认 false。

##### ! `AppId` 和 `Bucket` 的说明：

腾讯云官方 api 修改，去掉 `AppId` 概念，`Bucket` 需要传入这样的格式 `test-1250000000`。本插件，兼容两种配置方式，示例如下：

```js

// old api options

const options = {

  AppId: 'your AppId',

  Bucket: 'old Bucket',

  ...

};

```

```js

// new api options

const options = {

  Bucket: 'AppId-Bucket',

  ...

};

```

## TIPS

该插件基于 [腾讯云 COS Nodejs SDK V5](https://github.com/tencentyun/cos-nodejs-sdk-v5) 构建，可参考腾讯云官方文档 [Node.js SDK](https://cloud.tencent.com/document/product/436/8629)。