Class default

Index

Constructors

Methods

abortMultipartUpload append asyncSignatureUrl calculatePostSignature cancel completeMultipartUpload copy createVod delete deleteBucket deleteBucketCORS deleteBucketLifecycle deleteBucketLogging deleteBucketPolicy deleteBucketReferer deleteBucketWebsite deleteChannel deleteMulti generateObjectUrl get getACL getBucketACL getBucketCORS getBucketInfo getBucketLifecycle getBucketLocation getBucketLogging getBucketPolicy getBucketReferer getBucketWebsite getChannel getChannelHistory getChannelStatus getObjectUrl getRtmpUrl getStream getSymlink head initMultipartUpload isCancel list listBuckets listChannels listParts listUploads listV2 multipartUpload multipartUploadCopy put putACL putBucket putBucketACL putBucketCORS putBucketLifecycle putBucketLogging putBucketPolicy putBucketReferer putBucketWebsite putChannel putChannelStatus putMeta putStream putSymlink restore signatureUrl signatureUrlV4 uploadPart uploadPartCopy useBucket

Constructors

constructor

new default(options: Options): default
Parameters
- options: Options
Returns default
- Defined in index.d.ts:836

Methods

abortMultipartUpload

abortMultipartUpload(
    name: string,
    uploadId: string,
    options?: RequestOptions,
): Promise<NormalSuccessResponse>
Abort a multipart upload for object.
Parameters
- name: string
- uploadId: string
- Optionaloptions: RequestOptions
Returns Promise<NormalSuccessResponse>
- Defined in index.d.ts:1215

append

append(
    name: string,
    file: any,
    options?: AppendObjectOptions,
): Promise<AppendObjectResult>
Append an object to the bucket, it's almost same as put, but it can add content to existing object rather than override it.
Parameters
- name: string
- file: any
- Optionaloptions: AppendObjectOptions
Returns Promise<AppendObjectResult>
- Defined in index.d.ts:1048

asyncSignatureUrl

asyncSignatureUrl(name: string, options?: SignatureUrlOptions): Promise<string>
Basically the same as signatureUrl, if refreshSTSToken is configured asyncSignatureUrl will refresh stsToken
Parameters
- name: string
- Optionaloptions: SignatureUrlOptions
Returns Promise<string>
- Defined in index.d.ts:1123

calculatePostSignature

calculatePostSignature(policy: string | object): PostObjectParams
get postObject params.
Parameters
- policy: string | object
  policy config object or JSON string
Returns PostObjectParams
- Defined in index.d.ts:1235

cancel

cancel(
abort?: { name: string; options?: RequestOptions; uploadId: string },
): void
Cancel the current multipart upload operation. If abort is provided, it will also call abortMultipartUpload.
Parameters
- Optionalabort: { name: string; options?: RequestOptions; uploadId: string }
Returns void
- Defined in index.d.ts:1225

completeMultipartUpload

completeMultipartUpload(
    name: string,
    uploadId: string,
    parts: { etag: string; number: number }[],
    options?: CompleteMultipartUploadOptions,
): Promise<CompleteMultipartUploadResult>
After uploading all data parts, you must call the Complete Multipart Upload API to complete Multipart Upload for the entire file.
Parameters
- name: string
- uploadId: string
- parts: { etag: string; number: number }[]
- Optionaloptions: CompleteMultipartUploadOptions
Returns Promise<CompleteMultipartUploadResult>
- Defined in index.d.ts:1174

copy

copy(
    name: string,
    sourceName: string,
    options?: CopyObjectOptions,
): Promise<CopyAndPutMetaResult>
Copy an object from sourceName to name.
Parameters
- name: string
- sourceName: string
- Optionaloptions: CopyObjectOptions
Returns Promise<CopyAndPutMetaResult>
- Defined in index.d.ts:1083
copy(
    name: string,
    sourceName: string,
    sourceBucket?: string,
    options?: CopyObjectOptions,
): Promise<CopyAndPutMetaResult>
Copy an object from sourceName to name.
Parameters
- name: string
- sourceName: string
- OptionalsourceBucket: string
- Optionaloptions: CopyObjectOptions
Returns Promise<CopyAndPutMetaResult>
- Defined in index.d.ts:1084

createVod

createVod(
    id: string,
    name: string,
    time: { endTime: number; startTime: number },
    options?: RequestOptions,
): Promise<NormalSuccessResponse>
Create a VOD playlist for the channel.
Parameters
- id: string
- name: string
- time: { endTime: number; startTime: number }
- Optionaloptions: RequestOptions
Returns Promise<NormalSuccessResponse>
- Defined in index.d.ts:1301

delete

delete(name: string, options?: RequestOptions): Promise<DeleteResult>
Delete an object from the bucket.
Parameters
- name: string
- Optionaloptions: RequestOptions
Returns Promise<DeleteResult>
- Defined in index.d.ts:1078

deleteBucket

deleteBucket(
name: string,
options?: RequestOptions,
): Promise<NormalSuccessResponse>
Delete an empty bucket.
Parameters
- name: string
- Optionaloptions: RequestOptions
Returns Promise<NormalSuccessResponse>
- Defined in index.d.ts:862

deleteBucketCORS

deleteBucketCORS(name: string): Promise<NormalSuccessResponse>
Delete CORS rules of the bucket object.
Parameters
- name: string
Returns Promise<NormalSuccessResponse>
- Defined in index.d.ts:989

deleteBucketLifecycle

deleteBucketLifecycle(
name: string,
options?: RequestOptions,
): Promise<NormalSuccessResponse>
Delete the bucket object lifecycle.
Parameters
- name: string
- Optionaloptions: RequestOptions
Returns Promise<NormalSuccessResponse>
- Defined in index.d.ts:969

deleteBucketLogging

deleteBucketLogging(
name: string,
options?: RequestOptions,
): Promise<NormalSuccessResponse>
Delete the bucket logging settings.
Parameters
- name: string
- Optionaloptions: RequestOptions
Returns Promise<NormalSuccessResponse>
- Defined in index.d.ts:903

deleteBucketPolicy

deleteBucketPolicy(
name: string,
options?: RequestOptions,
): Promise<{ res: NormalSuccessResponse; status: number }>
Deletes the policy added for a bucket.
Parameters
- name: string
- Optionaloptions: RequestOptions
Returns Promise<{ res: NormalSuccessResponse; status: number }>
- Defined in index.d.ts:1012

deleteBucketReferer

deleteBucketReferer(
name: string,
options?: RequestOptions,
): Promise<NormalSuccessResponse>
Delete the bucket request Referer white list.
Parameters
- name: string
- Optionaloptions: RequestOptions
Returns Promise<NormalSuccessResponse>
- Defined in index.d.ts:946

deleteBucketWebsite

deleteBucketWebsite(
name: string,
options?: RequestOptions,
): Promise<NormalSuccessResponse>
Delete the bucket website config.
Parameters
- name: string
- Optionaloptions: RequestOptions
Returns Promise<NormalSuccessResponse>
- Defined in index.d.ts:922

deleteChannel

deleteChannel(
id: string,
options?: RequestOptions,
): Promise<NormalSuccessResponse>
Delete a live channel.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<NormalSuccessResponse>
- Defined in index.d.ts:1276

deleteMulti

deleteMulti(
names: string[],
options?: DeleteMultiOptions,
): Promise<DeleteMultiResult>
Delete multi objects in one request.
Parameters
- names: string[]
- Optionaloptions: DeleteMultiOptions
Returns Promise<DeleteMultiResult>
- Defined in index.d.ts:1099

generateObjectUrl

generateObjectUrl(name: string, baseUrl?: string): string
Get the Object url. If provide baseUrl, will use baseUrl instead the default bucket and endpoint. Suggest use generateObjectUrl instead of getObjectUrl.
Parameters
- name: string
- OptionalbaseUrl: string
Returns string
- Defined in index.d.ts:1058

get

get(
    name: string,
    file?: any,
    options?: GetObjectOptions,
): Promise<GetObjectResult>
Get an object from the bucket.
Parameters
- name: string
- Optionalfile: any
- Optionaloptions: GetObjectOptions
Returns Promise<GetObjectResult>
- Defined in index.d.ts:1068

getACL

getACL(name: string, options?: RequestOptions): Promise<GetACLResult>
Get object's ACL.
Parameters
- name: string
- Optionaloptions: RequestOptions
Returns Promise<GetACLResult>
- Defined in index.d.ts:1133

getBucketACL

getBucketACL(
name: string,
options?: RequestOptions,
): Promise<{ acl: string; res: NormalSuccessResponse }>
Get the bucket ACL. acl - acl settings string
Parameters
- name: string
- Optionaloptions: RequestOptions
Returns Promise<{ acl: string; res: NormalSuccessResponse }>
- Defined in index.d.ts:884

getBucketCORS

getBucketCORS(
name: string,
): Promise<{ res: NormalSuccessResponse; rules: CORSRule[] }>
Get CORS rules of the bucket object.
Parameters
- name: string
Returns Promise<{ res: NormalSuccessResponse; rules: CORSRule[] }>
- Defined in index.d.ts:984

getBucketInfo

getBucketInfo(name: string): Promise<any>
Get bucket information,include CreationDate、ExtranetEndpoint、IntranetEndpoint、Location、Name、StorageClass、 Owner、AccessControlList
Parameters
- name: string
Returns Promise<any>
- Defined in index.d.ts:867

getBucketLifecycle

getBucketLifecycle(
name: string,
options?: RequestOptions,
): Promise<{ res: NormalSuccessResponse; rules: LifecycleRule[] }>
Get the bucket object lifecycle.
Parameters
- name: string
- Optionaloptions: RequestOptions
Returns Promise<{ res: NormalSuccessResponse; rules: LifecycleRule[] }>
- Defined in index.d.ts:961

getBucketLocation

getBucketLocation(name: string): Promise<any>
Get bucket location
Parameters
- name: string
Returns Promise<any>
- Defined in index.d.ts:872

getBucketLogging

getBucketLogging(
    name: string,
    options?: RequestOptions,
): Promise<
    { enable: boolean; prefix: string
    | null; res: NormalSuccessResponse },
>
Get the bucket logging settings.
Parameters
- name: string
- Optionaloptions: RequestOptions
Returns Promise<{ enable: boolean; prefix: string | null; res: NormalSuccessResponse }>
- Defined in index.d.ts:895

getBucketPolicy

getBucketPolicy(
name: string,
options?: RequestOptions,
): Promise<GetBucketPolicyResult>
Obtains the policy for a bucket.
Parameters
- name: string
- Optionaloptions: RequestOptions
Returns Promise<GetBucketPolicyResult>
- Defined in index.d.ts:1007

getBucketReferer

getBucketReferer(
    name: string,
    options?: RequestOptions,
): Promise<
    { allowEmpty: boolean; referers: string[]; res: NormalSuccessResponse },
>
Get the bucket request Referer white list.
Parameters
- name: string
- Optionaloptions: RequestOptions
Returns Promise<{ allowEmpty: boolean; referers: string[]; res: NormalSuccessResponse }>
- Defined in index.d.ts:938

getBucketWebsite

getBucketWebsite(
name: string,
options?: RequestOptions,
): Promise<{ error: string; index: string; res: NormalSuccessResponse }>
Get the bucket website config.
Parameters
- name: string
- Optionaloptions: RequestOptions
Returns Promise<{ error: string; index: string; res: NormalSuccessResponse }>
- Defined in index.d.ts:914

getChannel

getChannel(
id: string,
options?: RequestOptions,
): Promise<{ data: PutChannelConf; res: NormalSuccessResponse }>
Get live channel info.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<{ data: PutChannelConf; res: NormalSuccessResponse }>
- Defined in index.d.ts:1268

getChannelHistory

getChannelHistory(
id: string,
options?: RequestOptions,
): Promise<ChannelHistoryResult>
Get the live channel history.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<ChannelHistoryResult>
- Defined in index.d.ts:1296

getChannelStatus

getChannelStatus(
id: string,
options?: RequestOptions,
): Promise<GetChannelResult>
Get the live channel status.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<GetChannelResult>
- Defined in index.d.ts:1286

getObjectUrl

getObjectUrl(name: string, baseUrl?: string): string
Get the Object url. If provide baseUrl, will use baseUrl instead the default endpoint.
Parameters
- name: string
- OptionalbaseUrl: string
Returns string
- Defined in index.d.ts:1053

getRtmpUrl

getRtmpUrl(channelId?: string, options?: GetRtmpUrlOptions): string
Get signatured rtmp url for publishing.
Parameters
- OptionalchannelId: string
- Optionaloptions: GetRtmpUrlOptions
Returns string
- Defined in index.d.ts:1311

getStream

getStream(name?: string, options?: GetStreamOptions): Promise<GetStreamResult>
Get an object read stream.
Parameters
- Optionalname: string
- Optionaloptions: GetStreamOptions
Returns Promise<GetStreamResult>
- Defined in index.d.ts:1073

getSymlink

getSymlink(
name: string,
options?: { headers?: object; timeout?: number; versionId?: string },
): Promise<{ res: NormalSuccessResponse; targetName: string }>
get symlink
Parameters
- name: string
- Optionaloptions: { headers?: object; timeout?: number; versionId?: string }
Returns Promise<{ res: NormalSuccessResponse; targetName: string }>
- Defined in index.d.ts:1254

head

head(name: string, options?: HeadObjectOptions): Promise<HeadObjectResult>
Head an object and get the meta info.
Parameters
- name: string
- Optionaloptions: HeadObjectOptions
Returns Promise<HeadObjectResult>
- Defined in index.d.ts:1063

initMultipartUpload

initMultipartUpload(
name: string,
options?: InitMultipartUploadOptions,
): Promise<InitMultipartUploadResult>
multi upload
Parameters
- name: string
- Optionaloptions: InitMultipartUploadOptions
Returns Promise<InitMultipartUploadResult>
- Defined in index.d.ts:1143

isCancel

isCancel(): boolean
Check if the upload has been cancelled.

Returns boolean
- Defined in index.d.ts:1230

list

list(
query: ListObjectsQuery | null,
options: RequestOptions,
): Promise<ListObjectResult>
List objects in the bucket.
Parameters
- query: ListObjectsQuery | null
- options: RequestOptions
Returns Promise<ListObjectResult>
- Defined in index.d.ts:1024

listBuckets

listBuckets(
query: ListBucketsQueryType | null,
options?: RequestOptions,
): Promise<Bucket[]>
List buckets in this account.
Parameters
- query: ListBucketsQueryType | null
- Optionaloptions: RequestOptions
Returns Promise<Bucket[]>
- Defined in index.d.ts:844

listChannels

listChannels(
query: ListChannelsQuery,
options?: RequestOptions,
): Promise<ListChannelsResult>
List channels.
Parameters
- query: ListChannelsQuery
- Optionaloptions: RequestOptions
Returns Promise<ListChannelsResult>
- Defined in index.d.ts:1291

listParts

listParts(
    name: string,
    uploadId: string,
    query?: ListPartsQuery,
    options?: RequestOptions,
): Promise<ListPartsResult>
The ListParts command can be used to list all successfully uploaded parts mapped to a specific upload ID, i.e.: those not completed and not aborted.
Parameters
- name: string
- uploadId: string
- Optionalquery: ListPartsQuery
- Optionaloptions: RequestOptions
Returns Promise<ListPartsResult>
- Defined in index.d.ts:1200

listUploads

listUploads(
query: ListUploadsQuery,
options?: RequestOptions,
): Promise<ListUploadsResult>
List on-going multipart uploads, i.e.: those not completed and not aborted.
Parameters
- query: ListUploadsQuery
- Optionaloptions: RequestOptions
Returns Promise<ListUploadsResult>
- Defined in index.d.ts:1210

listV2

listV2(
query: ListV2ObjectsQuery | null,
options?: RequestOptions,
): Promise<ListV2ObjectResult>
List Objects in the bucket.(V2)
Parameters
- query: ListV2ObjectsQuery | null
- Optionaloptions: RequestOptions
Returns Promise<ListV2ObjectResult>
- Defined in index.d.ts:1029

multipartUpload

multipartUpload(
    name: string,
    file: any,
    options: MultipartUploadOptions,
): Promise<MultipartUploadResult>
Upload file with OSS multipart.
Parameters
- name: string
- file: any
- options: MultipartUploadOptions
Returns Promise<MultipartUploadResult>
- Defined in index.d.ts:1184

multipartUploadCopy

multipartUploadCopy(
    name: string,
    sourceData: MultipartUploadCopySourceData,
    options?: MultipartUploadOptions,
): Promise<MultipartUploadCopyResult>
Copy file with OSS multipart. this function contains head, initMultipartUpload, uploadPartCopy, completeMultipartUpload. When copying a file larger than 1 GB, you should use the Upload Part Copy method. If you want to copy a file smaller than 1 GB, see Copy Object.
Parameters
- name: string
- sourceData: MultipartUploadCopySourceData
- Optionaloptions: MultipartUploadOptions
Returns Promise<MultipartUploadCopyResult>
- Defined in index.d.ts:1191

put

put(
    name: string,
    file: any,
    options?: PutObjectOptions,
): Promise<PutObjectResult>
Add an object to the bucket.
Parameters
- name: string
- file: any
- Optionaloptions: PutObjectOptions
Returns Promise<PutObjectResult>
- Defined in index.d.ts:1034

putACL

putACL(
    name: string,
    acl: ACLType,
    options?: RequestOptions,
): Promise<NormalSuccessResponse>
Set object's ACL.
Parameters
- name: string
- acl: ACLType
- Optionaloptions: RequestOptions
Returns Promise<NormalSuccessResponse>
- Defined in index.d.ts:1128

putBucket

putBucket(
name: string,
options?: PutBucketOptions,
): Promise<{ bucket: string; res: NormalSuccessResponse }>
Create a new bucket.
Parameters
- name: string
- Optionaloptions: PutBucketOptions
Returns Promise<{ bucket: string; res: NormalSuccessResponse }>
- Defined in index.d.ts:849

putBucketACL

putBucketACL(
    name: string,
    acl: ACLType,
    options?: RequestOptions,
): Promise<NormalSuccessResponse>
Update the bucket ACL.
Parameters
- name: string
- acl: ACLType
- Optionaloptions: RequestOptions
Returns Promise<NormalSuccessResponse>
- Defined in index.d.ts:878

putBucketCORS

putBucketCORS(
    name: string,
    rules: CORSRule[],
    options?: RequestOptions,
): Promise<NormalSuccessResponse>
Set CORS rules of the bucket object
Parameters
- name: string
- rules: CORSRule[]
- Optionaloptions: RequestOptions
Returns Promise<NormalSuccessResponse>
- Defined in index.d.ts:975

putBucketLifecycle

putBucketLifecycle(
    name: string,
    rules: LifecycleRule[],
    options?: RequestOptions,
): Promise<NormalSuccessResponse>
Set the bucket object lifecycle.
Parameters
- name: string
- rules: LifecycleRule[]
- Optionaloptions: RequestOptions
Returns Promise<NormalSuccessResponse>
- Defined in index.d.ts:952

putBucketLogging

putBucketLogging(
    name: string,
    prefix?: string,
    options?: RequestOptions,
): Promise<NormalSuccessResponse>
Update the bucket logging settings. Log file will create every one hour and name format: -YYYY-mm-DD-HH-MM-SS-UniqueString.
Parameters
- name: string
- Optionalprefix: string
- Optionaloptions: RequestOptions
Returns Promise<NormalSuccessResponse>
- Defined in index.d.ts:890

putBucketPolicy

putBucketPolicy(
    name: string,
    policy: BucketPolicy,
    options?: RequestOptions,
): Promise<{ res: NormalSuccessResponse; status: number }>
Adds or modify policy for a bucket.
Parameters
- name: string
- policy: BucketPolicy
- Optionaloptions: RequestOptions
Returns Promise<{ res: NormalSuccessResponse; status: number }>
- Defined in index.d.ts:995

putBucketReferer

putBucketReferer(
    name: string,
    allowEmpty: boolean,
    referers: string[],
    options?: RequestOptions,
): Promise<NormalSuccessResponse>
Set the bucket request Referer white list.
Parameters
- name: string
- allowEmpty: boolean
- referers: string[]
- Optionaloptions: RequestOptions
Returns Promise<NormalSuccessResponse>
- Defined in index.d.ts:928

putBucketWebsite

putBucketWebsite(
name: string,
config: PutBucketWebsiteConfig,
): Promise<NormalSuccessResponse>
Set the bucket as a static website.
Parameters
- name: string
- config: PutBucketWebsiteConfig
Returns Promise<NormalSuccessResponse>
- Defined in index.d.ts:909

putChannel

putChannel(
    id: string,
    conf: PutChannelConf,
    options?: RequestOptions,
): Promise<PutChannelResult>
Create a live channel.
Parameters
- id: string
- conf: PutChannelConf
- Optionaloptions: RequestOptions
Returns Promise<PutChannelResult>
- Defined in index.d.ts:1263

putChannelStatus

putChannelStatus(
    id: string,
    status?: string,
    options?: RequestOptions,
): Promise<NormalSuccessResponse>
Change the live channel status.
Parameters
- id: string
- Optionalstatus: string
- Optionaloptions: RequestOptions
Returns Promise<NormalSuccessResponse>
- Defined in index.d.ts:1281

putMeta

putMeta(
    name: string,
    meta: UserMeta,
    options: RequestOptions,
): Promise<CopyAndPutMetaResult>
Set an exists object meta.
Parameters
- name: string
- meta: UserMeta
- options: RequestOptions
Returns Promise<CopyAndPutMetaResult>
- Defined in index.d.ts:1094

putStream

putStream(
    name: string,
    stream: any,
    options?: PutStreamOptions,
): Promise<{ name: string; res: NormalSuccessResponse }>
Add a stream object to the bucket.
Parameters
- name: string
- stream: any
- Optionaloptions: PutStreamOptions
Returns Promise<{ name: string; res: NormalSuccessResponse }>
- Defined in index.d.ts:1039

putSymlink

putSymlink(
    name: string,
    targetName: string,
    options?: PutSymlinkOptions,
): Promise<{ res: NormalSuccessResponse }>
put symlink
Parameters
- name: string
- targetName: string
- Optionaloptions: PutSymlinkOptions
Returns Promise<{ res: NormalSuccessResponse }>
- Defined in index.d.ts:1245

restore

restore(name: string, options?: RequestOptions): Promise<NormalSuccessResponse>
Restore Object.
Parameters
- name: string
- Optionaloptions: RequestOptions
Returns Promise<NormalSuccessResponse>
- Defined in index.d.ts:1138

signatureUrl

signatureUrl(name: string, options?: SignatureUrlOptions): string
Create a signature url for download or upload object. When you put object with signatureUrl ,you need to pass Content-Type.Please look at the example.
Parameters
- name: string
- Optionaloptions: SignatureUrlOptions
Returns string
- Defined in index.d.ts:1104

signatureUrlV4

signatureUrlV4(
    method: HTTPMethods,
    expires: number,
    request: { headers?: object; queries?: object } | undefined,
    objectName: string,
    additionalHeaders?: string[],
): Promise<string>
Generate a signed URL for V4 of an OSS resource and share the URL to allow authorized third-party users to access the resource.
Parameters
- method: HTTPMethods
- expires: number
- request: { headers?: object; queries?: object } | undefined
- objectName: string
- OptionaladditionalHeaders: string[]
Returns Promise<string>
- Defined in index.d.ts:1109

uploadPart

uploadPart(
    name: string,
    uploadId: string,
    partNo: number,
    file: any,
    start: number,
    end: number,
    options?: RequestOptions,
): Promise<UploadPartResult>
After initiating a Multipart Upload event, you can upload data in parts based on the specified object name and Upload ID.
Parameters
- name: string
- uploadId: string
- partNo: number
- file: any
- start: number
- end: number
- Optionaloptions: RequestOptions
Returns Promise<UploadPartResult>
- Defined in index.d.ts:1148

uploadPartCopy

uploadPartCopy(
    name: string,
    uploadId: string,
    partNo: number,
    range: string,
    sourceData: { sourceBucketName: string; sourceKey: string },
    options: { headers?: object; timeout?: number },
): Promise<UploadPartResult>
Using Upload Part Copy, you can copy data from an existing object and upload a part of the data. When copying a file larger than 1 GB, you must use the Upload Part Copy method. If you want to copy a file smaller than 1 GB, see Copy Object.
Parameters
- name: string
- uploadId: string
- partNo: number
- range: string
- sourceData: { sourceBucketName: string; sourceKey: string }
- options: { headers?: object; timeout?: number }
Returns Promise<UploadPartResult>
- Defined in index.d.ts:1162

useBucket

useBucket(name: string): void
Use the bucket.
Parameters
- name: string
Returns void
- Defined in index.d.ts:857

Class default

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns default

Methods

abortMultipartUpload

Parameters

Returns Promise<NormalSuccessResponse>

append

Parameters

Returns Promise<AppendObjectResult>

asyncSignatureUrl

Parameters

Returns Promise<string>

calculatePostSignature

Parameters

Returns PostObjectParams

cancel

Parameters

Returns void

completeMultipartUpload

Parameters

Returns Promise<CompleteMultipartUploadResult>

copy

Parameters

Returns Promise<CopyAndPutMetaResult>

Parameters

Returns Promise<CopyAndPutMetaResult>

createVod

Parameters

Returns Promise<NormalSuccessResponse>

delete

Parameters

Returns Promise<DeleteResult>

deleteBucket

Parameters

Returns Promise<NormalSuccessResponse>

deleteBucketCORS

Parameters

Returns Promise<NormalSuccessResponse>

deleteBucketLifecycle

Parameters

Returns Promise<NormalSuccessResponse>

deleteBucketLogging

Parameters

Returns Promise<NormalSuccessResponse>

deleteBucketPolicy

Parameters

Returns Promise<{ res: NormalSuccessResponse; status: number }>

deleteBucketReferer

Parameters

Returns Promise<NormalSuccessResponse>

deleteBucketWebsite

Parameters

Returns Promise<NormalSuccessResponse>

deleteChannel

Parameters

Returns Promise<NormalSuccessResponse>

deleteMulti

Parameters

Returns Promise<DeleteMultiResult>

generateObjectUrl

Parameters

Returns string

get

Parameters

Returns Promise<GetObjectResult>

getACL

Parameters

Returns Promise<GetACLResult>

getBucketACL

Parameters

Returns Promise<{ acl: string; res: NormalSuccessResponse }>

getBucketCORS

Parameters

Returns Promise<{ res: NormalSuccessResponse; rules: CORSRule[] }>