qiao-cos

4.5.6 • Public • Published

qiao-cos

npm version npm downloads

nodejs 下腾讯云 cos 常见 api 封装

install

安装

npm i qiao-cos

config.json

配置文件

{
    "SecretId": "your secret id",
    "SecretKey": "your secret key",
    "Region": "your bucket",
    "Bucket": "your bucket",
}

cli

也支持cli使用,详见qiao-cos-cli

use

使用

// cjs
const COS = require('qiao-cos');

// mjs
import COS from 'qiao-cos';

qcos

实例

// config
const config = require('./config.json');

// qiao-cos
const qcos = COS(config);

cdn

cdn相关操作

cdnSign

cos配套的cdn鉴权

  • destPath
    • 类型: string
    • 说明: cos 的目标路径,这里以/开头
  • timeout
    • 类型: number
    • 说明: 有效时间,单位是秒
  • return
    • 类型: string
    • 说明: 添加sign和t后的url
  • 备注
const destPath = '/202309/2e266e54-8ddc-42d9-a772-a24514c5d17b.png';

// timeout is 0
const url = qcos.cdnSign(destPath);

// timeout is 10s
const url = qcos.cdnSign(destPath, 10);

bucket

bucket相关操作

listBuckets

列出存储桶

  • return
    • 类型: object
    • 说明: 存储桶相关信息
const res = await qcos.listBuckets();

listObjects

列出对象列表

  • prefix
    • 类型: string
    • 说明: 筛选的前缀
  • max
    • 类型: number
    • 说明: 单次返回最大条数,默认1000,最大1000
  • marker
    • 类型: string
    • 说明: 上次返回的结尾
  • return
    • 类型: object
    • 说明: 对象相关信息
const res = await qcos.listObjects();

listObjectsAll

列出所有对象

  • prefix
    • 类型: string
    • 说明: 筛选的前缀
  • max
    • 类型: number
    • 说明: 单次返回最大条数,默认1000,最大1000
  • return
    • 类型: object
    • 说明: 对象相关信息
const res = await qcos.listObjectsAll();

upload

uploadFile

上传文件

  • destPath
    • 类型: string
    • 说明: cos 的目标路径
  • sourceFile
    • 类型: string
    • 说明: 待上传的文件路径
  • return
    • 类型: object
    • 说明: cos 返回的结果
const destPath = 'test/test.js';
const sourceFile = '/your/test.js';

const rs = await qcos.uploadFile(destPath, sourceFile);
console.log(rs);

uploadFolder

上传文件夹

  • destPath
    • 类型: string
    • 说明: cos 的目标路径
  • sourceFolder
    • 类型: string
    • 说明: 待上传的文件夹路径
  • return
    • 类型: object
    • 说明: cos 返回的结果
const destPath = 'test';
const sourceFolder = '/your/folder';

const rs = await qcos.uploadFolder(destPath, sourceFolder);
console.log(rs);

Package Sidebar

Install

npm i qiao-cos

Weekly Downloads

66

Version

4.5.6

License

MIT

Unpacked Size

20.2 kB

Total Files

9

Last publish

Collaborators

  • npm_insistime