Class NosClientMultipartUploadExt

Hierarchy

NosBaseClient
- NosClientMultipartUploadExt
  - NosClient

Index

Constructors

constructor

Properties

options

Methods

Constructors

constructor

new NosClientMultipartUploadExt(options: NosClientOptions): NosClientMultipartUploadExt

Inherited from NosBaseClient.constructor
- Defined in client.ts:30
Parameters
- options: NosClientOptions
Returns NosClientMultipartUploadExt

Properties

options

options: NosClientOptions & object

Methods

Private _request

_request(method: string, headers: any, resource: Resource, body?: any): Promise<Response>

Inherited from NosBaseClient._request
- Defined in client.ts:51
底层请求方法包装

Parameters
- method: string
  
  请求方法
- headers: any
  
  头信息
- resource: Resource
  
  资源信息，也会序列化到 Url 上面
- Optional body: any
Returns Promise<Response>

abortMultipartUpload

abortMultipartUpload(params: AbortMultipartUploadParams): Promise<boolean>
abortMultipartUpload(params: AbortMultipartUploadParams, cb: Callback<boolean>): void

- Defined in exts/multipart-upload.ts:48
终止分片上传

Parameters
- params: AbortMultipartUploadParams
Returns Promise<boolean>

isSuccess 是否成功终止分片上传
- Defined in exts/multipart-upload.ts:49
Parameters
- params: AbortMultipartUploadParams
- cb: Callback<boolean>
Returns void

completeMultipartUpload

completeMultipartUpload(params: CompleteMultipartParams): Promise<MultipartUploadObject>
completeMultipartUpload(params: CompleteMultipartParams, cb: Callback<MultipartUploadObject>): void

- Defined in exts/multipart-upload.ts:172
完成分片上传。这是分片上传的结束，如果你上传完成之后但是没有执行完成上传，那么服务器并不会对分片进行拼接。

Parameters
- params: CompleteMultipartParams
Returns Promise<MultipartUploadObject>
- Defined in exts/multipart-upload.ts:173
Parameters
- params: CompleteMultipartParams
- cb: Callback<MultipartUploadObject>
Returns void

Protected handleRequestError

handleRequestError(resp: Response): Promise<Response>

Inherited from NosBaseClient.handleRequestError
- Defined in client.ts:81
Parameters
- resp: Response
Returns Promise<Response>

initMultipartUpload

initMultipartUpload(params: InitMultipartUploadParams): Promise<string>
initMultipartUpload(params: InitMultipartUploadParams, cb: Callback<string>): void

- Defined in exts/multipart-upload.ts:29
初始化分片上传。一切分片上传操作都需要在初始化后获取到 uploadId 之后进行操作

Parameters
- params: InitMultipartUploadParams
Returns Promise<string>

uploadId 上传 ID
- Defined in exts/multipart-upload.ts:30
Parameters
- params: InitMultipartUploadParams
- cb: Callback<string>
Returns void

listMultipartUpload

listMultipartUpload(params?: ListMultipartParams): Promise<ListMultipartResult>
listMultipartUpload(params: ListMultipartParams, cb: Callback<ListMultipartResult>): void

- Defined in exts/multipart-upload.ts:129
获取所有的未完成的分片对象

Parameters
- Optional params: ListMultipartParams
Returns Promise<ListMultipartResult>
- Defined in exts/multipart-upload.ts:130
Parameters
- params: ListMultipartParams
- cb: Callback<ListMultipartResult>
Returns void

listParts

listParts(params: ListPartsOptions): Promise<ListPartsResult>
listParts(params: ListPartsOptions, cb: Callback<ListPartsResult>): void

- Defined in exts/multipart-upload.ts:91
获取一个对象的所有分片，必须保证这个对象并未完成分片的全部上传

Parameters
- params: ListPartsOptions
Returns Promise<ListPartsResult>
- Defined in exts/multipart-upload.ts:92
Parameters
- params: ListPartsOptions
- cb: Callback<ListPartsResult>
Returns void

putBigObject

putBigObject(params: PutBigObjectParams): Promise<MultipartUploadObject>
putBigObject(params: PutBigObjectParams, cb: Callback<MultipartUploadObject>): void

- Defined in exts/multipart-upload.ts:195
使用分片上传大文件。如果你不想自己手写分片文件的上传，你可以使用这个接口。自动创建、上传、完成分片，省时省力，方便快捷。

Parameters
- params: PutBigObjectParams
Returns Promise<MultipartUploadObject>
- Defined in exts/multipart-upload.ts:196
Parameters
- params: PutBigObjectParams
- cb: Callback<MultipartUploadObject>
Returns void

Protected request

request(method: string, headers: any, resource: Resource, body?: any): Promise<Response>

Inherited from NosBaseClient.request
- Defined in client.ts:92
Parameters
- method: string
- headers: any
- resource: Resource
- Optional body: any
Returns Promise<Response>

Protected requestBody

requestBody(method: string, headers: any, resource: Resource, body?: any): Promise<any>

Inherited from NosBaseClient.requestBody
- Defined in client.ts:97
Parameters
- method: string
- headers: any
- resource: Resource
- Optional body: any
Returns Promise<any>

uploadMultipart

uploadMultipart(params: UploadMultipartParams): Promise<Part>
uploadMultipart(params: UploadMultipartParams, cb: Callback<Part>): void

- Defined in exts/multipart-upload.ts:67
上传分片，使用初始化得到的 uploadId

Parameters
- params: UploadMultipartParams
Returns Promise<Part>

part 上传的分片
- Defined in exts/multipart-upload.ts:68
Parameters
- params: UploadMultipartParams
- cb: Callback<Part>
Returns void

Protected validateBinaryParams

validateBinaryParams(params: OperateBinaryObjectParams): object

Inherited from NosBaseClient.validateBinaryParams
- Defined in client.ts:131
Parameters
- params: OperateBinaryObjectParams
Returns object
- headers: any
- resource: Resource
- sourceBucket: string
- targetBucket: string

Protected validateParams

validateParams(params: OperateObjectParams | OperateOptionalBucketParams): object

Inherited from NosBaseClient.validateParams
- Defined in client.ts:102
Parameters
- params: OperateObjectParams | OperateOptionalBucketParams
Returns object
- bucket: string
- headers: any
- resource: Resource

Generated using TypeDoc