Skip to content

Commit d841de7

Browse files
authored
feat: 优化 d.ts (#224)
* feat: 优化 d.ts * feat: 优化 d.ts
1 parent 02372ad commit d841de7

File tree

2 files changed

+11
-14
lines changed

2 files changed

+11
-14
lines changed

index.d.ts

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1279,9 +1279,14 @@ declare namespace COS {
12791279
VersionId?: string;
12801280
}
12811281

1282+
type MetaHeaders = {
1283+
/** 包括用户自定义元数据头部后缀和用户自定义元数据信息,将作为对象元数据保存,大小限制为2KB,注意:用户自定义元数据信息支持下划线(_),但用户自定义元数据头部后缀不支持下划线,仅支持减号(-) */
1284+
[k in `x-cos-meta-${string}`]?: string;
1285+
}
1286+
12821287
// putObject
12831288
/** putObject 接口参数 */
1284-
interface PutObjectParams extends ObjectParams {
1289+
interface PutObjectParams extends ObjectParams, MetaHeaders {
12851290
/** 要上传对象内容 */
12861291
Body: UploadBody;
12871292
/** 上传的文件大小,单位 Byte 字节,如果不传且 Body 是流,会走服务端流式上传 */
@@ -1312,8 +1317,6 @@ declare namespace COS {
13121317
GrantFullControl?: Grant;
13131318
/** 对象存储类型。例如 STANDARD | STANDARD_IA | ARCHIVE | DEEP_ARCHIVE | INTELLIGENT_TIERING | MAZ_STANDARD | MAZ_STANDARD_IA | MAZ_INTELLIGENT_TIERING。默认值:STANDARD */
13141319
StorageClass?: StorageClass;
1315-
/** 包括用户自定义元数据头部后缀和用户自定义元数据信息,将作为对象元数据保存,大小限制为2KB,注意:用户自定义元数据信息支持下划线(_),但用户自定义元数据头部后缀不支持下划线,仅支持减号(-) */
1316-
'x-cos-meta-*'?: string;
13171320
/** 加密相关 */
13181321
ServerSideEncryption?: string;
13191322
SSECustomerAlgorithm?: string;
@@ -1507,7 +1510,7 @@ Bulk:批量模式,恢复时间为24 - 48小时。 */
15071510

15081511
// putObjectCopy
15091512
/** putObjectCopy 接口参数 */
1510-
interface PutObjectCopyParams extends ObjectParams {
1513+
interface PutObjectCopyParams extends ObjectParams, MetaHeaders {
15111514
/** 源对象的 URL,其中对象键需经过 URLEncode,可以通过 versionId 参数指定源对象的版本,例如: sourcebucket-1250000001.cos.ap-shanghai.myqcloud.com/example-%E8%85%BE%E8%AE%AF%E4%BA%91.jpg 或 sourcebucket-1250000001.cos.ap-shanghai.myqcloud.com/example-%E8%85%BE%E8%AE%AF%E4%BA%91.jpg?versionId=MTg0NDUxNzYzMDc0NDMzNDExOTc */
15121515
CopySource: string;
15131516
/** 是否复制源对象的元数据信息,枚举值:Copy,Replaced,默认为 Copy。如果标记为 Copy,则复制源对象的元数据信息;如果标记为 Replaced,则按本次请求的请求头中的元数据信息作为目标对象的元数据信息;当目标对象和源对象为同一对象时,即用户试图修改元数据时,则标记必须为 Replaced */
@@ -1542,8 +1545,6 @@ Bulk:批量模式,恢复时间为24 - 48小时。 */
15421545
ContentType?: string;
15431546
/** RFC 2616 中定义的缓存失效时间,将作为目标对象元数据保存 */
15441547
Expires?: string;
1545-
/** 包括用户自定义元数据头部后缀和用户自定义元数据信息,将作为目标对象元数据保存,大小限制为2KB。注意:用户自定义元数据信息支持下划线(_),但用户自定义元数据头部后缀不支持下划线,仅支持减号(-) */
1546-
'x-cos-meta-*'?: string;
15471548
}
15481549
/** putObjectCopy 接口返回值 */
15491550
interface PutObjectCopyResult extends GeneralResult {
@@ -1582,7 +1583,7 @@ Bulk:批量模式,恢复时间为24 - 48小时。 */
15821583

15831584
// multipartInit
15841585
/** multipartInit 接口参数 */
1585-
interface MultipartInitParams extends ObjectParams {
1586+
interface MultipartInitParams extends ObjectParams, MetaHeaders {
15861587
/** RFC 2616 中定义的缓存指令,将作为对象元数据保存 */
15871588
CacheControl?: string;
15881589
/** RFC 2616 中定义的文件名称,将作为对象元数据保存 */
@@ -1607,8 +1608,6 @@ Bulk:批量模式,恢复时间为24 - 48小时。 */
16071608
Query?: Query;
16081609
/** 对象存储类型。例如 STANDARD | STANDARD_IA | ARCHIVE | DEEP_ARCHIVE | INTELLIGENT_TIERING | MAZ_STANDARD | MAZ_STANDARD_IA | MAZ_INTELLIGENT_TIERING。默认值:STANDARD */
16091610
StorageClass?: StorageClass;
1610-
/** 包括用户自定义元数据头部后缀和用户自定义元数据信息,将作为对象元数据保存,大小限制为2KB。注意:用户自定义元数据信息支持下划线(_),但用户自定义元数据头部后缀不支持下划线,仅支持减号(-) */
1611-
'x-cos-meta-*'?: string;
16121611
}
16131612
/** multipartInit 接口返回值 */
16141613
interface MultipartInitResult extends GeneralResult {
@@ -1769,7 +1768,7 @@ Bulk:批量模式,恢复时间为24 - 48小时。 */
17691768

17701769
// sliceUploadFile
17711770
/** sliceUploadFile 接口参数 */
1772-
interface SliceUploadFileParams extends ObjectParams {
1771+
interface SliceUploadFileParams extends ObjectParams, MetaHeaders {
17731772
/** 要上传的本地文件路径 */
17741773
FilePath: string;
17751774
/** 分块上传时,每片的字节数大小,默认值1048576(1MB) */
@@ -1802,8 +1801,6 @@ Bulk:批量模式,恢复时间为24 - 48小时。 */
18021801
GrantFullControl?: Grant;
18031802
/** 对象存储类型。枚举值 STANDARD | STANDARD_IA | ARCHIVE | DEEP_ARCHIVE | INTELLIGENT_TIERING | MAZ_STANDARD | MAZ_STANDARD_IA | MAZ_INTELLIGENT_TIERING @see https://cloud.tencent.com/document/product/436/33417 */
18041803
StorageClass?: StorageClass;
1805-
/** 包括用户自定义元数据头部后缀和用户自定义元数据信息,将作为对象元数据保存,大小限制为2KB,注意:用户自定义元数据信息支持下划线(_),但用户自定义元数据头部后缀不支持下划线,仅支持减号(-) */
1806-
'x-cos-meta-*'?: string;
18071804
/** 加密相关 */
18081805
ServerSideEncryption?: string;
18091806
SSECustomerAlgorithm?: string;
@@ -1922,7 +1919,7 @@ Bulk:批量模式,恢复时间为24 - 48小时。 */
19221919
/** 使用 sliceCopyFile 分块复制文件时,每片的大小字节数,默认值10485760(10MB) */
19231920
CopyChunkSize?: number;
19241921
/** 分片复制进度回调方法 */
1925-
onProgress: onProgress;
1922+
onProgress?: onProgress;
19261923
}
19271924
/** sliceCopyFile 接口返回值 */
19281925
interface SliceCopyFileResult extends GeneralResult {}

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "cos-nodejs-sdk-v5",
3-
"version": "2.14.6",
3+
"version": "2.14.7",
44
"description": "cos nodejs sdk v5",
55
"main": "index.js",
66
"types": "index.d.ts",

0 commit comments

Comments
 (0)