Skip to content

Commit 0d41f0d

Browse files
authored
upd:完善demo和d.ts (#149)
Co-authored-by: chrisftian <chrisftian@tencent.com>
1 parent 7f612b1 commit 0d41f0d

File tree

3 files changed

+32
-11
lines changed

3 files changed

+32
-11
lines changed

demo/config.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
var config = {
2-
SecretId: process.env.SecretId,
3-
SecretKey: process.env.SecretKey,
4-
Bucket: process.env.Bucket,
5-
Region: process.env.Region,
6-
Uin: process.env.Uin,
2+
SecretId: process.env.SecretId || '',
3+
SecretKey: process.env.SecretKey || '',
4+
Bucket: process.env.Bucket || '',
5+
Region: process.env.Region || '',
6+
Uin: process.env.Uin || '',
77
};
88

99
module.exports = config;

demo/demo.js

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1335,20 +1335,20 @@ function moveObject() {
13351335
Key: source,
13361336
Body: 'hello!',
13371337
}, function (err, data) {
1338-
if (err) return logger.log(err);
1338+
if (err) return console.log(err);
13391339
cos.putObjectCopy({
13401340
Bucket: config.Bucket,
13411341
Region: config.Region,
13421342
Key: target,
13431343
CopySource: copySource,
13441344
}, function (err, data) {
1345-
if (err) return logger.log(err);
1345+
if (err) return console.log(err);
13461346
cos.deleteObject({
13471347
Bucket: config.Bucket,
13481348
Region: config.Region,
13491349
Key: source,
13501350
}, function (err, data) {
1351-
logger.log(err || data);
1351+
console.log(err || data);
13521352
});
13531353
});
13541354
});
@@ -1391,7 +1391,7 @@ function uploadFolder() {
13911391

13921392
/* 创建文件夹 */
13931393
function createFolder() {
1394-
cos.getBucket({
1394+
cos.putObject({
13951395
Bucket: config.Bucket,
13961396
Region: config.Region,
13971397
Key: 'folder/', // 对象存储没有实际的文件夹,可以创建一个路径以 / 结尾的空对象表示,能在部分场景中满足文件夹使用需要
@@ -1543,7 +1543,7 @@ function appendObject_continue() {
15431543
}, function(err, data) {
15441544
if (err) return console.log(err);
15451545
// 首先取到要追加的文件当前长度,即需要上送的Position
1546-
var position = data.headers['content-length'];
1546+
var position = data.headers && data.headers['content-length'];
15471547
cos.appendObject({
15481548
Bucket: config.Bucket, // Bucket 格式:test-1250000000
15491549
Region: config.Region,
@@ -1553,7 +1553,7 @@ function appendObject_continue() {
15531553
},
15541554
function(err, data) {
15551555
// 也可以取到下一次上传的position继续追加上传
1556-
var nextPosition = data.headers['x-cos-next-append-position'];
1556+
var nextPosition = data.headers && data.headers['x-cos-next-append-position'];
15571557
console.log(err || data);
15581558
})
15591559
});
@@ -2753,6 +2753,7 @@ function DescribeAuditJob() {
27532753
var jobId = 'st3bb560af647911ec919652540024deb5';
27542754
cos.request({
27552755
Url: `https://${config.Bucket}.ci.${config.Region}.myqcloud.com/text/auditing/${jobId}`,
2756+
Method: 'GET',
27562757
}, function (err, data) {
27572758
console.log(err || data.Response.JobsDetail);
27582759
});

index.d.ts

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1861,6 +1861,8 @@ Bulk:批量模式,恢复时间为24 - 48小时。 */
18611861
// request
18621862
/** request 接口参数 */
18631863
interface RequestParams extends BucketParams {
1864+
Bucket?: Bucket;
1865+
Region?: Region;
18641866
/** 操作方法,如 get,post,delete, head 等 HTTP 方法 */
18651867
Method: string,
18661868
/** 请求的对象键,最前面不带 / */
@@ -1875,10 +1877,12 @@ Bulk:批量模式,恢复时间为24 - 48小时。 */
18751877
Url?: string,
18761878
/** 返回值body是否不需要解析 */
18771879
RawBody?: boolean,
1880+
ContentType?: string,
18781881
}
18791882
/** Request 接口返回值 */
18801883
interface RequestResult extends GeneralResult {
18811884
Body?: Buffer,
1885+
Response?: any,
18821886
}
18831887

18841888
// getObjectUrl
@@ -1903,6 +1907,18 @@ Bulk:批量模式,恢复时间为24 - 48小时。 */
19031907
Url: string
19041908
}
19051909

1910+
interface DownloadFileParams {
1911+
Bucket: Bucket,
1912+
Region: Region,
1913+
Key: Key,
1914+
FilePath: string,
1915+
ChunkSize?: number,
1916+
ParallelLimit?: number,
1917+
RetryTimes?: number,
1918+
onTaskReady?: (TaskId: COS.TaskId) => void,
1919+
onProgress?: onProgress,
1920+
}
1921+
19061922
// getV4Auth
19071923
interface GetV4AuthParams {
19081924
/** 计算签名用的密钥 SecretId,如果不传会用实例本身的凭证,可选 */
@@ -2293,6 +2309,10 @@ declare class COS {
22932309
appendObject(params: COS.AppendObjectParams, callback: (err: COS.CosError, data: COS.GeneralResult) => void): void;
22942310
appendObject(params: COS.AppendObjectParams): Promise<COS.GeneralResult>;
22952311

2312+
/** 分块下载 @see https://cloud.tencent.com/document/product/436/64981#.E5.88.86.E5.9D.97.E4.B8.8B.E8.BD.BD.E5.AF.B9.E8.B1.A1 */
2313+
downloadFile(params: COS.DownloadFileParams, callback: (err: COS.CosError, data: COS.GeneralResult) => void): void;
2314+
downloadFile(params: COS.DownloadFileParams): Promise<COS.GeneralResult>;
2315+
22962316
/** 获取 COS JSON API (v4) 签名 @see https://cloud.tencent.com/document/product/436/6054 */
22972317
getV4Auth(params: COS.GetV4AuthParams): COS.Authorization;
22982318

0 commit comments

Comments
 (0)