@@ -13,7 +13,7 @@ Aliyun OSS(Object Storage Service) Node.js Client.
13
13
## Install
14
14
15
15
``` bash
16
- npm install oss-client
16
+ npm install oss-client@latest-1
17
17
```
18
18
19
19
## License
@@ -42,111 +42,111 @@ All operation use es7 async/await to implement. All api is async function.
42
42
- [ Create A Bucket Instance] ( #create-a-bucket-instance )
43
43
- [ oss(options)] ( #ossoptions )
44
44
- [ Bucket Operations] ( #bucket-operations )
45
- - [ .listBuckets(query[ , options] )] ( #listbucketsquery-options )
46
- - [ .putBucket(name[ , options] )] ( #putbucketname-options )
47
- - [ .deleteBucket(name[ , options] )] ( #deletebucketname-options )
45
+ - [ .listBuckets(query\ [ , options\ ] )] ( #listbucketsquery-options )
46
+ - [ .putBucket(name\ [ , options\ ] )] ( #putbucketname-options )
47
+ - [ .deleteBucket(name\ [ , options\ ] )] ( #deletebucketname-options )
48
48
- [ .useBucket(name)] ( #usebucketname )
49
49
- [ .getBucketInfo(name)] ( #getbucketinfoname )
50
50
- [ .getBucketStat(name)] ( #getbucketstatname )
51
51
- [ .getBucketLocation(name)] ( #getbucketlocationname )
52
- - [ .putBucketACL(name, acl[ , options] )] ( #putbucketaclname-acl-options )
53
- - [ .getBucketACL(name[ , options] )] ( #getbucketaclname-options )
54
- - [ .putBucketLogging(name, prefix[ , options] )] ( #putbucketloggingname-prefix-options )
55
- - [ .getBucketLogging(name[ , options] )] ( #getbucketloggingname-options )
56
- - [ .deleteBucketLogging(name[ , options] )] ( #deletebucketloggingname-options )
57
- - [ .putBucketWebsite(name, config[ , options] )] ( #putbucketwebsitename-config-options )
58
- - [ .getBucketWebsite(name[ , options] )] ( #getbucketwebsitename-options )
59
- - [ .deleteBucketWebsite(name[ , options] )] ( #deletebucketwebsitename-options )
60
- - [ .putBucketReferer(name, allowEmpty, referers[ , options] )] ( #putbucketreferername-allowempty-referers-options )
61
- - [ .getBucketReferer(name[ , options] )] ( #getbucketreferername-options )
62
- - [ .deleteBucketReferer(name[ , options] )] ( #deletebucketreferername-options )
63
- - [ .putBucketLifecycle(name, rules[ , options] )] ( #putbucketlifecyclename-rules-options )
64
- - [ .getBucketLifecycle(name[ , options] )] ( #getbucketlifecyclename-options )
65
- - [ .deleteBucketLifecycle(name[ , options] )] ( #deletebucketlifecyclename-options )
66
- - [ .putBucketCORS(name, rules[ , options] )] ( #putbucketcorsname-rules-options )
67
- - [ .getBucketCORS(name[ , options] )] ( #getbucketcorsname-options )
68
- - [ .deleteBucketCORS(name[ , options] )] ( #deletebucketcorsname-options )
69
- - [ .getBucketRequestPayment(bucketName[ , options] )] ( #getbucketrequestpaymentbucketname-options )
70
- - [ .putBucketRequestPayment(bucketName, payer[ , options] )] ( #putbucketrequestpaymentbucketname-payer-options )
52
+ - [ .putBucketACL(name, acl\ [ , options\ ] )] ( #putbucketaclname-acl-options )
53
+ - [ .getBucketACL(name\ [ , options\ ] )] ( #getbucketaclname-options )
54
+ - [ .putBucketLogging(name, prefix\ [ , options\ ] )] ( #putbucketloggingname-prefix-options )
55
+ - [ .getBucketLogging(name\ [ , options\ ] )] ( #getbucketloggingname-options )
56
+ - [ .deleteBucketLogging(name\ [ , options\ ] )] ( #deletebucketloggingname-options )
57
+ - [ .putBucketWebsite(name, config\ [ , options\ ] )] ( #putbucketwebsitename-config-options )
58
+ - [ .getBucketWebsite(name\ [ , options\ ] )] ( #getbucketwebsitename-options )
59
+ - [ .deleteBucketWebsite(name\ [ , options\ ] )] ( #deletebucketwebsitename-options )
60
+ - [ .putBucketReferer(name, allowEmpty, referers\ [ , options\ ] )] ( #putbucketreferername-allowempty-referers-options )
61
+ - [ .getBucketReferer(name\ [ , options\ ] )] ( #getbucketreferername-options )
62
+ - [ .deleteBucketReferer(name\ [ , options\ ] )] ( #deletebucketreferername-options )
63
+ - [ .putBucketLifecycle(name, rules\ [ , options\ ] )] ( #putbucketlifecyclename-rules-options )
64
+ - [ .getBucketLifecycle(name\ [ , options\ ] )] ( #getbucketlifecyclename-options )
65
+ - [ .deleteBucketLifecycle(name\ [ , options\ ] )] ( #deletebucketlifecyclename-options )
66
+ - [ .putBucketCORS(name, rules\ [ , options\ ] )] ( #putbucketcorsname-rules-options )
67
+ - [ .getBucketCORS(name\ [ , options\ ] )] ( #getbucketcorsname-options )
68
+ - [ .deleteBucketCORS(name\ [ , options\ ] )] ( #deletebucketcorsname-options )
69
+ - [ .getBucketRequestPayment(bucketName\ [ , options\ ] )] ( #getbucketrequestpaymentbucketname-options )
70
+ - [ .putBucketRequestPayment(bucketName, payer\ [ , options\ ] )] ( #putbucketrequestpaymentbucketname-payer-options )
71
71
- [ .putBucketEncryption(name, rules)] ( #putbucketencryptionname-rules )
72
72
- [ .getBucketEncryption(name)] ( #getbucketencryptionname )
73
73
- [ .deleteBucketEncryption(name)] ( #deletebucketencryptionname )
74
- - [ .putBucketTags(name, tag[ , options] )] ( #putbuckettagsname-tag-options )
75
- - [ .getBucketTags(name[ , options] )] ( #getbuckettagsname-options )
76
- - [ .deleteBucketTags(name[ , options] )] ( #deletebuckettagsname-options )
77
- - [ .putBucketPolicy(name, policy[ , options] )] ( #putbucketpolicyname-policy-options )
78
- - [ .getBucketPolicy(name[ , options] )] ( #getbucketpolicyname-options )
79
- - [ .deleteBucketPolicy(name[ , options] )] ( #deletebucketpolicyname-options )
80
- - [ .getBucketVersioning(name[ , options] )] ( #getbucketversioningname-options )
81
- - [ .putBucketVersioning(name, status[ , options] )] ( #putbucketversioningname-status-options )
82
- - [ .getBucketInventory(name, inventoryId[ , options] )] ( #getbucketinventoryname-inventoryid-options )
83
- - [ putBucketInventory(name, inventory[ , options] )] ( #putbucketinventoryname-inventory-options )
84
- - [ deleteBucketInventory(name, inventoryId[ , options] )] ( #deletebucketinventoryname-inventoryid-options )
85
- - [ listBucketInventory(name[ , options] )] ( #listbucketinventoryname-options )
86
- - [ .abortBucketWorm(name[ , options] )] ( #abortbucketwormname-options )
87
- - [ .completeBucketWorm(name, wormId[ , options] )] ( #completebucketwormname-wormid-options )
88
- - [ .extendBucketWorm(name, wormId, days[ , options] )] ( #extendbucketwormname-wormid-days-options )
89
- - [ .getBucketWorm(name[ , options] )] ( #getbucketwormname-options )
90
- - [ .initiateBucketWorm(name, days[ , options] )] ( #initiatebucketwormname-days-options )
74
+ - [ .putBucketTags(name, tag\ [ , options\ ] )] ( #putbuckettagsname-tag-options )
75
+ - [ .getBucketTags(name\ [ , options\ ] )] ( #getbuckettagsname-options )
76
+ - [ .deleteBucketTags(name\ [ , options\ ] )] ( #deletebuckettagsname-options )
77
+ - [ .putBucketPolicy(name, policy\ [ , options\ ] )] ( #putbucketpolicyname-policy-options )
78
+ - [ .getBucketPolicy(name\ [ , options\ ] )] ( #getbucketpolicyname-options )
79
+ - [ .deleteBucketPolicy(name\ [ , options\ ] )] ( #deletebucketpolicyname-options )
80
+ - [ .getBucketVersioning(name\ [ , options\ ] )] ( #getbucketversioningname-options )
81
+ - [ .putBucketVersioning(name, status\ [ , options\ ] )] ( #putbucketversioningname-status-options )
82
+ - [ .getBucketInventory(name, inventoryId\ [ , options\ ] )] ( #getbucketinventoryname-inventoryid-options )
83
+ - [ putBucketInventory(name, inventory\ [ , options\ ] )] ( #putbucketinventoryname-inventory-options )
84
+ - [ deleteBucketInventory(name, inventoryId\ [ , options\ ] )] ( #deletebucketinventoryname-inventoryid-options )
85
+ - [ listBucketInventory(name\ [ , options\ ] )] ( #listbucketinventoryname-options )
86
+ - [ .abortBucketWorm(name\ [ , options\ ] )] ( #abortbucketwormname-options )
87
+ - [ .completeBucketWorm(name, wormId\ [ , options\ ] )] ( #completebucketwormname-wormid-options )
88
+ - [ .extendBucketWorm(name, wormId, days\ [ , options\ ] )] ( #extendbucketwormname-wormid-days-options )
89
+ - [ .getBucketWorm(name\ [ , options\ ] )] ( #getbucketwormname-options )
90
+ - [ .initiateBucketWorm(name, days\ [ , options\ ] )] ( #initiatebucketwormname-days-options )
91
91
- [ Object Operations] ( #object-operations )
92
- - [ .put(name, file[ , options] )] ( #putname-file-options )
93
- - [ .putStream(name, stream[ , options] )] ( #putstreamname-stream-options )
94
- - [ .append(name, file[ , options] )] ( #appendname-file-options )
95
- - [ .getObjectUrl(name[ , baseUrl] )] ( #getobjecturlname-baseurl )
96
- - [ .generateObjectUrl(name[ , baseUrl] )] ( #generateobjecturlname-baseurl )
97
- - [ .head(name[ , options] )] ( #headname-options )
98
- - [ .getObjectMeta(name[ , options] )] ( #getobjectmetaname-options )
99
- - [ .get(name[ , file, options] )] ( #getname-file-options )
100
- - [ .getStream(name[ , options] )] ( #getstreamname-options )
101
- - [ .delete(name[ , options] )] ( #deletename-options )
102
- - [ .copy(name, sourceName[ , sourceBucket, options] )] ( #copyname-sourcename-sourcebucket-options )
103
- - [ .putMeta(name, meta[ , options] )] ( #putmetaname-meta-options )
104
- - [ .deleteMulti(names[ , options] )] ( #deletemultinames-options )
105
- - [ .list(query[ , options] )] ( #listquery-options )
106
- - [ .listV2(query[ , options] )] ( #listv2query-options )
107
- - [ .getBucketVersions(query[ , options] )] ( #getbucketversionsquery-options )
108
- - [ .signatureUrl(name[ , options] )] ( #signatureurlname-options )
109
- - [ .asyncSignatureUrl(name[ , options] )] ( #asyncsignatureurlname-options )
110
- - [ .putACL(name, acl[ , options] )] ( #putaclname-acl-options )
111
- - [ .getACL(name[ , options] )] ( #getaclname-options )
112
- - [ .restore(name[ , options] )] ( #restorename-options )
113
- - [ .putSymlink(name, targetName[ , options] )] ( #putsymlinkname-targetname-options )
114
- - [ .getSymlink(name[ , options] )] ( #getsymlinkname-options )
115
- - [ .initMultipartUpload(name[ , options] )] ( #initmultipartuploadname-options )
116
- - [ .uploadPart(name, uploadId, partNo, file, start, end[ , options] )] ( #uploadpartname-uploadid-partno-file-start-end-options )
117
- - [ .uploadPartCopy(name, uploadId, partNo, range, sourceData[ , options] )] ( #uploadpartcopyname-uploadid-partno-range-sourcedata-options )
118
- - [ .completeMultipartUpload(name, uploadId, parts[ , options] )] ( #completemultipartuploadname-uploadid-parts-options )
119
- - [ .multipartUpload(name, file[ , options] )] ( #multipartuploadname-file-options )
120
- - [ .multipartUploadCopy(name, sourceData[ , options] )] ( #multipartuploadcopyname-sourcedata-options )
121
- - [ .listParts(name, uploadId[ , query, options] )] ( #listpartsname-uploadid-query-options )
122
- - [ .listUploads(query[ , options] )] ( #listuploadsquery-options )
123
- - [ .abortMultipartUpload(name, uploadId[ , options] )] ( #abortmultipartuploadname-uploadid-options )
92
+ - [ .put(name, file\ [ , options\ ] )] ( #putname-file-options )
93
+ - [ .putStream(name, stream\ [ , options\ ] )] ( #putstreamname-stream-options )
94
+ - [ .append(name, file\ [ , options\ ] )] ( #appendname-file-options )
95
+ - [ .getObjectUrl(name\ [ , baseUrl\ ] )] ( #getobjecturlname-baseurl )
96
+ - [ .generateObjectUrl(name\ [ , baseUrl\ ] )] ( #generateobjecturlname-baseurl )
97
+ - [ .head(name\ [ , options\ ] )] ( #headname-options )
98
+ - [ .getObjectMeta(name\ [ , options\ ] )] ( #getobjectmetaname-options )
99
+ - [ .get(name\ [ , file, options\ ] )] ( #getname-file-options )
100
+ - [ .getStream(name\ [ , options\ ] )] ( #getstreamname-options )
101
+ - [ .delete(name\ [ , options\ ] )] ( #deletename-options )
102
+ - [ .copy(name, sourceName\ [ , sourceBucket, options\ ] )] ( #copyname-sourcename-sourcebucket-options )
103
+ - [ .putMeta(name, meta\ [ , options\ ] )] ( #putmetaname-meta-options )
104
+ - [ .deleteMulti(names\ [ , options\ ] )] ( #deletemultinames-options )
105
+ - [ .list(query\ [ , options\ ] )] ( #listquery-options )
106
+ - [ .listV2(query\ [ , options\ ] )] ( #listv2query-options )
107
+ - [ .getBucketVersions(query\ [ , options\ ] )] ( #getbucketversionsquery-options )
108
+ - [ .signatureUrl(name\ [ , options\ ] )] ( #signatureurlname-options )
109
+ - [ .asyncSignatureUrl(name\ [ , options\ ] )] ( #asyncsignatureurlname-options )
110
+ - [ .putACL(name, acl\ [ , options\ ] )] ( #putaclname-acl-options )
111
+ - [ .getACL(name\ [ , options\ ] )] ( #getaclname-options )
112
+ - [ .restore(name\ [ , options\ ] )] ( #restorename-options )
113
+ - [ .putSymlink(name, targetName\ [ , options\ ] )] ( #putsymlinkname-targetname-options )
114
+ - [ .getSymlink(name\ [ , options\ ] )] ( #getsymlinkname-options )
115
+ - [ .initMultipartUpload(name\ [ , options\ ] )] ( #initmultipartuploadname-options )
116
+ - [ .uploadPart(name, uploadId, partNo, file, start, end\ [ , options\ ] )] ( #uploadpartname-uploadid-partno-file-start-end-options )
117
+ - [ .uploadPartCopy(name, uploadId, partNo, range, sourceData\ [ , options\ ] )] ( #uploadpartcopyname-uploadid-partno-range-sourcedata-options )
118
+ - [ .completeMultipartUpload(name, uploadId, parts\ [ , options\ ] )] ( #completemultipartuploadname-uploadid-parts-options )
119
+ - [ .multipartUpload(name, file\ [ , options\ ] )] ( #multipartuploadname-file-options )
120
+ - [ .multipartUploadCopy(name, sourceData\ [ , options\ ] )] ( #multipartuploadcopyname-sourcedata-options )
121
+ - [ .listParts(name, uploadId\ [ , query, options\ ] )] ( #listpartsname-uploadid-query-options )
122
+ - [ .listUploads(query\ [ , options\ ] )] ( #listuploadsquery-options )
123
+ - [ .abortMultipartUpload(name, uploadId\ [ , options\ ] )] ( #abortmultipartuploadname-uploadid-options )
124
124
- [ .calculatePostSignature(policy)] ( #calculatepostsignaturepolicy )
125
- - [ .getObjectTagging(name[ , options] )] ( #getobjecttaggingname-options )
126
- - [ .putObjectTagging(name, tag[ , options] )] ( #putobjecttaggingname-tag-options )
127
- - [ .deleteObjectTagging(name[ , options] )] ( #deleteobjecttaggingname-options )
128
- - [ .processObjectSave(sourceObject, targetObject, process[ , targetBucket] )] ( #processobjectsavesourceobject-targetobject-process-targetbucket )
125
+ - [ .getObjectTagging(name\ [ , options\ ] )] ( #getobjecttaggingname-options )
126
+ - [ .putObjectTagging(name, tag\ [ , options\ ] )] ( #putobjecttaggingname-tag-options )
127
+ - [ .deleteObjectTagging(name\ [ , options\ ] )] ( #deleteobjecttaggingname-options )
128
+ - [ .processObjectSave(sourceObject, targetObject, process\ [ , targetBucket\ ] )] ( #processobjectsavesourceobject-targetobject-process-targetbucket )
129
129
- [ RTMP Operations] ( #rtmp-operations )
130
- - [ .putChannel(id, conf[ , options] )] ( #putchannelid-conf-options )
131
- - [ .getChannel(id[ , options] )] ( #getchannelid-options )
132
- - [ .deleteChannel(id[ , options] )] ( #deletechannelid-options )
133
- - [ .putChannelStatus(id, status[ , options] )] ( #putchannelstatusid-status-options )
134
- - [ .getChannelStatus(id[ , options] )] ( #getchannelstatusid-options )
135
- - [ .listChannels(query[ , options] )] ( #listchannelsquery-options )
136
- - [ .getChannelHistory(id[ , options] )] ( #getchannelhistoryid-options )
137
- - [ .createVod(id, name, time[ , options] )] ( #createvodid-name-time-options )
138
- - [ .getRtmpUrl(channelId[ , options] )] ( #getrtmpurlchannelid-options )
130
+ - [ .putChannel(id, conf\ [ , options\ ] )] ( #putchannelid-conf-options )
131
+ - [ .getChannel(id\ [ , options\ ] )] ( #getchannelid-options )
132
+ - [ .deleteChannel(id\ [ , options\ ] )] ( #deletechannelid-options )
133
+ - [ .putChannelStatus(id, status\ [ , options\ ] )] ( #putchannelstatusid-status-options )
134
+ - [ .getChannelStatus(id\ [ , options\ ] )] ( #getchannelstatusid-options )
135
+ - [ .listChannels(query\ [ , options\ ] )] ( #listchannelsquery-options )
136
+ - [ .getChannelHistory(id\ [ , options\ ] )] ( #getchannelhistoryid-options )
137
+ - [ .createVod(id, name, time\ [ , options\ ] )] ( #createvodid-name-time-options )
138
+ - [ .getRtmpUrl(channelId\ [ , options\ ] )] ( #getrtmpurlchannelid-options )
139
139
- [ Create A Image Service Instance] ( #create-a-image-service-instance )
140
140
- [ oss.ImageClient(options)] ( #ossimageclientoptions )
141
141
- [ Image Operations] ( #image-operations )
142
- - [ imgClient.get(name, file[ , options] )] ( #imgclientgetname-file-options )
143
- - [ imgClient.getStream(name[ , options] )] ( #imgclientgetstreamname-options )
144
- - [ imgClient.getExif(name[ , options] )] ( #imgclientgetexifname-options )
145
- - [ imgClient.getInfo(name[ , options] )] ( #imgclientgetinfoname-options )
146
- - [ imgClient.putStyle(name, style[ , options] )] ( #imgclientputstylename-style-options )
147
- - [ imgClient.getStyle(name[ , options] )] ( #imgclientgetstylename-options )
148
- - [ imgClient.listStyle([ options] )] ( #imgclientliststyleoptions )
149
- - [ imgClient.deleteStyle(name[ , options] )] ( #imgclientdeletestylename-options )
142
+ - [ imgClient.get(name, file\ [ , options\ ] )] ( #imgclientgetname-file-options )
143
+ - [ imgClient.getStream(name\ [ , options\ ] )] ( #imgclientgetstreamname-options )
144
+ - [ imgClient.getExif(name\ [ , options\ ] )] ( #imgclientgetexifname-options )
145
+ - [ imgClient.getInfo(name\ [ , options\ ] )] ( #imgclientgetinfoname-options )
146
+ - [ imgClient.putStyle(name, style\ [ , options\ ] )] ( #imgclientputstylename-style-options )
147
+ - [ imgClient.getStyle(name\ [ , options\ ] )] ( #imgclientgetstylename-options )
148
+ - [ imgClient.listStyle(\ [ options\ ] )] ( #imgclientliststyleoptions )
149
+ - [ imgClient.deleteStyle(name\ [ , options\ ] )] ( #imgclientdeletestylename-options )
150
150
- [ imgClient.signatureUrl(name)] ( #imgclientsignatureurlname )
151
151
- [ Cluster Mode] ( #cluster-mode )
152
152
- [ Get Methods] ( #get-methods )
0 commit comments