# cos-wx-sdk-v5

> 小程序 SDK for [腾讯云对象存储服务](https://cloud.tencent.com/product/cos)

Latest version **1.8.0** (published 2025-05-19) · ISC license · 0 weekly downloads

## Install

```sh
npm install cos-wx-sdk-v5
pnpm add cos-wx-sdk-v5
yarn add cos-wx-sdk-v5
bun add cos-wx-sdk-v5
```

## Health

**Score 25/100 (F)** — status: maintenance-mode.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.8.0 |
| Published | 2025-05-19 |
| First published | 2018-01-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 957.4 KB |
| Known vulnerabilities | 0 (+6 in 1 direct dependencies) |
| Install scripts | yes |
| Author | carsonxu |
| Maintainers | galenyip, yinshawnrao, carsonxu, tianfeng, wonderswang |

## Links

- npm: https://www.npmjs.com/package/cos-wx-sdk-v5
- Repository: https://github.com/tencentyun/cos-wx-sdk-v5
- Homepage: https://github.com/tencentyun/cos-wx-sdk-v5#readme
- Issues: https://github.com/tencentyun/cos-wx-sdk-v5/issues
- npm.io page: https://npm.io/package/cos-wx-sdk-v5

## Dependencies (2)

- [mime](https://npm.io/package/mime.md) ^2.4.6
- [fast-xml-parser](https://npm.io/package/fast-xml-parser.md) 4.5.0

## Recent versions

- 1.8.0 (latest) — 2025-05-19
- 1.9.0-beta.1 (beta) — 2025-05-27
- 1.9.0-beta.0 — 2025-04-24
- 1.7.2 — 2024-07-25
- 1.7.1 — 2024-06-12
- 1.7.0 — 2024-05-27
- 1.6.2 — 2024-04-16
- 1.6.1 — 2024-03-25
- 1.6.0 — 2024-03-05
- 1.5.0 — 2024-01-24
- 1.4.13 — 2023-12-06
- 1.4.12 — 2023-08-03
- 1.4.11 — 2023-07-26
- 1.4.10 — 2023-01-04
- 1.4.9 — 2022-12-29
- … 52 more at https://npm.io/package/cos-wx-sdk-v5/versions

## README

## 快速入门

微信小程序 SDK for [腾讯云对象存储服务](https://cloud.tencent.com/product/cos)

### 一、前期准备

1. 到 (COS对象存储控制台)[https://console.cloud.tencent.com/cos4] 创建存储桶，得到 Bucket（存储桶名称） 和 Region（地域名称）
2. 到 (控制台密钥管理)[https://console.cloud.tencent.com/capi] 获取您的项目 SecretId 和 SecretKey

### 二、计算签名

由于签名计算放在前端会暴露 SecretId 和 SecretKey，我们把签名计算过程放在后端实现，前端通过 ajax 向后端获取签名结果，正式部署时请再后端加一层自己网站本身的权限检验。

这里提供 [NodeJS 的签名示例](https://github.com/tencentyun/cos-js-sdk-v5/blob/master/server/)，其他语言，请参照对应的 [XML SDK](https://cloud.tencent.com/document/product/436/6474)

### 三、上传例子

1. 把 demo/lib/cos-wx-sdk-v5.js 复制到自己小程序项目代码里，在需要上传文件的地方贴以下代码

```javascript

// 存储桶名称，由bucketname-appid 组成，appid必须填入，可以在COS控制台查看存储桶名称。 https://console.cloud.tencent.com/cos5/bucket
var Bucket = 'test-1250000000';
// 存储桶Region可以在COS控制台指定存储桶的概览页查看 https://console.cloud.tencent.com/cos5/bucket/ 
// 关于地域的详情见 https://cloud.tencent.com/document/product/436/6224
var Region = 'ap-guangzhou';

// 初始化实例
const cos = new COS({
    SimpleUploadMethod: 'putObject', // 强烈建议，高级上传、批量上传内部对小文件做简单上传时使用putObject,sdk版本至少需要v1.3.0
    getAuthorization: function (options, callback) {
        // 初始化时不会调用，只有调用 cos 方法（例如 cos.putObject）时才会进入
        // 异步获取临时密钥
        // 服务端 JS 示例：https://github.com/tencentyun/cos-js-sdk-v5/blob/master/server/
        // 服务端其他语言参考 COS STS SDK ：https://github.com/tencentyun/qcloud-cos-sts-sdk
        // STS 详细文档指引看：https://cloud.tencent.com/document/product/436/14048
        wx.request({
            url: 'https://example.com/server/sts', // url 替换成您自己的后端服务
            data: {
                bucket: options.Bucket,
                region: options.Region,
            },
            dataType: 'json',
            success: function (result) {
                const data = result.data;
                const credentials = data && data.credentials;
                if (!data || !credentials) return console.error('credentials invalid');
                // 检查credentials格式
                console.log(credentials);
                callback({
                    TmpSecretId: credentials.tmpSecretId,
                    TmpSecretKey: credentials.tmpSecretKey,
                    // v1.2.0之前版本的 SDK 使用 XCosSecurityToken 而不是 SecurityToken
                    SecurityToken: credentials.sessionToken,
                    // 建议返回服务器时间作为签名的开始时间，避免用户浏览器本地时间偏差过大导致签名错误
                    StartTime: data.startTime, // 时间戳，单位秒，如：1580000000
                    ExpiredTime: data.expiredTime, // 时间戳，单位秒，如：1580000900
                });
            }
        });
    }
});


// 选择文件
wx.chooseImage({
    count: 1, // 默认9
    sizeType: ['original'], // 可以指定是原图还是压缩图，默认用原图
    sourceType: ['album', 'camera'], // 可以指定来源是相册还是相机，默认二者都有
    success: function (res) {
        var filePath = res.tempFiles[0].path;
        var filename = filePath.substr(filePath.lastIndexOf('/') + 1);
        cos.postObject({
            Bucket: Bucket,
            Region: Region,
            Key: filename,
            FilePath: filePath,
            onProgress: function (info) {
                console.log(JSON.stringify(info));
            }
        }, function (err, data) {
            console.log(err || data);
        });
    }
});
```

## 说明文档 

[使用例子](demo/demo-sdk.js)

[快速入门](https://cloud.tencent.com/document/product/436/31953)

[接口文档](https://cloud.tencent.com/document/product/436/31953)

---
_Source: https://npm.io/package/cos-wx-sdk-v5 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._