NosClient | @xgheaven/nos-node-sdk

Hierarchy

Index

Constructors

constructor

Properties

options

Constructors

constructor

new NosClient(options: NosClientOptions): NosClient

Inherited from NosBaseClient.constructor

Overrides NosBaseClient.constructor
- Defined in client.ts:30
Parameters
- options: NosClientOptions
Returns NosClient

Properties

options

options: NosClientOptions & object

Methods

Private _request

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

Inherited from NosBaseClient._request

Overrides 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

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

Parameters
- params: AbortMultipartUploadParams
Returns Promise<boolean>

isSuccess 是否成功终止分片上传
Inherited from NosClientMultipartUploadExt.abortMultipartUpload
- 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

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

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

copyObject

copyObject(params: CopyObjectParams): Promise<void>
copyObject(params: CopyObjectParams, cb: Callback<void>): void

Inherited from NosClientObjectExt.copyObject
- Defined in exts/object.ts:189
复制对象

Parameters
- params: CopyObjectParams
Returns Promise<void>
Inherited from NosClientObjectExt.copyObject
- Defined in exts/object.ts:190
Parameters
- params: CopyObjectParams
- cb: Callback<void>
Returns void

createToken

createToken(params: CreateTokenParams): Token

Inherited from NosClientAuthExt.createToken
- Defined in exts/auth.ts:44
创建上传凭证，返回 Token 对象，里面有 putPolicy 和 sign 字段，前端可以通过此构建上传 Token

Parameters
- params: CreateTokenParams
Returns Token

createTokenString

createTokenString(params: CreateTokenParams): string

Inherited from NosClientAuthExt.createTokenString
- Defined in exts/auth.ts:76
创建上传凭证字符串，对 createToken 的简单包装，直接返回 accessKey:sign:putPolicy 字符串

Parameters
- params: CreateTokenParams
Returns string

deleteBucket

deleteBucket(params: OperateBucketParams): Promise<void>
deleteBucket(params: OperateBucketParams, cb: Callback<void>): void

Inherited from NosClientBucketExt.deleteBucket
- Defined in exts/bucket.ts:107
删除 Bucket

Parameters
- params: OperateBucketParams
Returns Promise<void>
Inherited from NosClientBucketExt.deleteBucket
- Defined in exts/bucket.ts:108
Parameters
- params: OperateBucketParams
- cb: Callback<void>
Returns void

deleteMultiObject

deleteMultiObject(params: DeleteMultiObjectParams): Promise<DeleteMultiObjectErrorInfo[]>
deleteMultiObject(params: DeleteMultiObjectParams, cb: Callback<DeleteMultiObjectErrorInfo[]>): void

Inherited from NosClientObjectExt.deleteMultiObject
- Defined in exts/object.ts:261
批量删除对象。

Parameters
- params: DeleteMultiObjectParams
Returns Promise<DeleteMultiObjectErrorInfo[]>

errors 删除失败的错误列表
Inherited from NosClientObjectExt.deleteMultiObject
- Defined in exts/object.ts:262
Parameters
- params: DeleteMultiObjectParams
- cb: Callback<DeleteMultiObjectErrorInfo[]>
Returns void

deleteObject

deleteObject(params: DeleteObjectParams): Promise<void>
deleteObject(params: DeleteObjectParams, cb: Callback<void>): void

Inherited from NosClientObjectExt.deleteObject
- Defined in exts/object.ts:224
删除对象

Parameters
- params: DeleteObjectParams
Returns Promise<void>
Inherited from NosClientObjectExt.deleteObject
- Defined in exts/object.ts:225
Parameters
- params: DeleteObjectParams
- cb: Callback<void>
Returns void

ensureBucket

ensureBucket(params: PutBucketParams): Promise<void>
ensureBucket(params: PutBucketParams, cb: Callback<void>): void

Inherited from NosClientBucketExt.ensureBucket
- Defined in exts/bucket.ts:75
确保 Bucket 存在。如果不存在，会自动创建，如果存在，不做任何操作。

Parameters
- params: PutBucketParams
Returns Promise<void>
Inherited from NosClientBucketExt.ensureBucket
- Defined in exts/bucket.ts:76
Parameters
- params: PutBucketParams
- cb: Callback<void>
Returns void

getBucketAcl

getBucketAcl(params: OperateBucketParams): Promise<BucketAcl>
getBucketAcl(params: OperateBucketParams, cb: Callback<BucketAcl>): void

Inherited from NosClientBucketExt.getBucketAcl
- Defined in exts/bucket.ts:126
获取 Bucket 的权限

Parameters
- params: OperateBucketParams
Returns Promise<BucketAcl>
Inherited from NosClientBucketExt.getBucketAcl
- Defined in exts/bucket.ts:127
Parameters
- params: OperateBucketParams
- cb: Callback<BucketAcl>
Returns void

getBucketLocation

getBucketLocation(params: OperateBucketParams): Promise<BucketLocation>
getBucketLocation(params: OperateBucketParams, cb: Callback<BucketLocation>): void

Inherited from NosClientBucketExt.getBucketLocation
- Defined in exts/bucket.ts:155
获取 Bucket 的地域位置

Parameters
- params: OperateBucketParams
Returns Promise<BucketLocation>
Inherited from NosClientBucketExt.getBucketLocation
- Defined in exts/bucket.ts:156
Parameters
- params: OperateBucketParams
- cb: Callback<BucketLocation>
Returns void

getObject

getObject(params: GetObjectStreamParams): Promise<ReadableStream>
getObject(params: GetObjectBufferParams): Promise<Buffer>
getObject(params: GetObjectStringParams): Promise<string>
getObject(params: GetObjectStreamParams, cb: Callback<ReadableStream>): void
getObject(params: GetObjectBufferParams, cb: Callback<Buffer>): void
getObject(params: GetObjectStringParams, cb: Callback<string>): void

Inherited from NosClientObjectExt.getObject
- Defined in exts/object.ts:109
获取对象内容。支持以 Buffer/string/Stream 的形式返回，建议使用 Stream 形式。如果你能确保返回的文件大小在合理的范围，不会导致占用过多的内容，比如说一张图片，一个文本文件等，可以直接使用 Buffer 或者 string，否则请使用 Stream

Parameters
- params: GetObjectStreamParams
Returns Promise<ReadableStream>
Inherited from NosClientObjectExt.getObject
- Defined in exts/object.ts:110
Parameters
- params: GetObjectBufferParams
Returns Promise<Buffer>
Inherited from NosClientObjectExt.getObject
- Defined in exts/object.ts:111
Parameters
- params: GetObjectStringParams
Returns Promise<string>
Inherited from NosClientObjectExt.getObject
- Defined in exts/object.ts:112
Parameters
- params: GetObjectStreamParams
- cb: Callback<ReadableStream>
Returns void
Inherited from NosClientObjectExt.getObject
- Defined in exts/object.ts:113
Parameters
- params: GetObjectBufferParams
- cb: Callback<Buffer>
Returns void
Inherited from NosClientObjectExt.getObject
- Defined in exts/object.ts:114
Parameters
- params: GetObjectStringParams
- cb: Callback<string>
Returns void

getObjectUrl

getObjectUrl(params: GetObjectUrlParams): Promise<string>
getObjectUrl(params: GetObjectUrlParams, cb: Callback<string>): void

Inherited from NosClientObjectExt.getObjectUrl
- Defined in exts/object.ts:201
获取对象的可访问 Url

Parameters
- params: GetObjectUrlParams
Returns Promise<string>
Inherited from NosClientObjectExt.getObjectUrl
- Defined in exts/object.ts:202
Parameters
- params: GetObjectUrlParams
- cb: Callback<string>
Returns void

Protected handleRequestError

handleRequestError(resp: Response): Promise<Response>

Inherited from NosBaseClient.handleRequestError

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

headObject

headObject(params: HeadObjectParams): Promise<HeadObjectResult>
headObject(params: HeadObjectParams, cb: Callback<HeadObjectResult>): void

Inherited from NosClientObjectExt.headObject
- Defined in exts/object.ts:145
获取对象元信息。类似于 HTTP head 操作。

Parameters
- params: HeadObjectParams
Returns Promise<HeadObjectResult>
Inherited from NosClientObjectExt.headObject
- Defined in exts/object.ts:146
Parameters
- params: HeadObjectParams
- cb: Callback<HeadObjectResult>
Returns void

initMultipartUpload

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

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

Parameters
- params: InitMultipartUploadParams
Returns Promise<string>

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

isBucketExist

isBucketExist(params: OperateBucketParams): Promise<boolean>
isBucketExist(params: OperateBucketParams, cb: Callback<boolean>): void

Inherited from NosClientBucketExt.isBucketExist
- Defined in exts/bucket.ts:92
检查一个 Bucket 是否存在

Parameters
- params: OperateBucketParams
Returns Promise<boolean>
Inherited from NosClientBucketExt.isBucketExist
- Defined in exts/bucket.ts:93
Parameters
- params: OperateBucketParams
- cb: Callback<boolean>
Returns void

isObjectExist

isObjectExist(params: OperateObjectParams): Promise<boolean>
isObjectExist(params: OperateObjectParams, cb: Callback<boolean>): void

Inherited from NosClientObjectExt.isObjectExist
- Defined in exts/object.ts:171
检查文件是否存在

Parameters
- params: OperateObjectParams
Returns Promise<boolean>
Inherited from NosClientObjectExt.isObjectExist
- Defined in exts/object.ts:172
Parameters
- params: OperateObjectParams
- cb: Callback<boolean>
Returns void

listBucket

listBucket(): Promise<ListBucketResult>
listBucket(cb: Callback<ListBucketResult>): void

Inherited from NosClientBucketExt.listBucket
- Defined in exts/bucket.ts:22
获取全部 Bucket

Returns Promise<ListBucketResult>
Inherited from NosClientBucketExt.listBucket
- Defined in exts/bucket.ts:23
Parameters
- cb: Callback<ListBucketResult>
Returns void

listMultipartUpload

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

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

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

listObject

listObject(params?: ListObjectParams): Promise<ListObjectResult>
listObject(params: ListObjectParams, cb: Callback<ListObjectResult>): void

Inherited from NosClientObjectExt.listObject
- Defined in exts/object.ts:45
获取对象列表

Parameters
- Optional params: ListObjectParams
Returns Promise<ListObjectResult>
Inherited from NosClientObjectExt.listObject
- Defined in exts/object.ts:46
Parameters
- params: ListObjectParams
- cb: Callback<ListObjectResult>
Returns void

listParts

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

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

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

moveObject

moveObject(params: MoveObjectParams): Promise<void>
moveObject(params: MoveObjectParams, cb: Callback<void>): void

Inherited from NosClientObjectExt.moveObject
- Defined in exts/object.ts:243
移动对象

Parameters
- params: MoveObjectParams
Returns Promise<void>
Inherited from NosClientObjectExt.moveObject
- Defined in exts/object.ts:244
Parameters
- params: MoveObjectParams
- cb: Callback<void>
Returns void

putBigObject

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

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

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

putBucket

putBucket(params: PutBucketParams): Promise<void>
putBucket(params: PutBucketParams, cb: Callback<void>): void

Inherited from NosClientBucketExt.putBucket
- Defined in exts/bucket.ts:55
添加一个 Bucket

Parameters
- params: PutBucketParams
Returns Promise<void>
Inherited from NosClientBucketExt.putBucket
- Defined in exts/bucket.ts:56
Parameters
- params: PutBucketParams
- cb: Callback<void>
Returns void

putObject

putObject(params: PutObjectParams): Promise<PutObjectResult>
putObject(params: PutObjectParams, cb: Callback<PutObjectResult>): void

Inherited from NosClientObjectExt.putObject
- Defined in exts/object.ts:80
上传对象

Parameters
- params: PutObjectParams
Returns Promise<PutObjectResult>
Inherited from NosClientObjectExt.putObject
- Defined in exts/object.ts:81
Parameters
- params: PutObjectParams
- cb: Callback<PutObjectResult>
Returns void

Protected request

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

Inherited from NosBaseClient.request

Overrides 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

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

setBucketAcl

setBucketAcl(params: SetBucketAclParams): Promise<void>
setBucketAcl(params: SetBucketAclParams, cb: Callback<void>): void

Inherited from NosClientBucketExt.setBucketAcl
- Defined in exts/bucket.ts:142
设置 Bucket 的权限

Parameters
- params: SetBucketAclParams
Returns Promise<void>
Inherited from NosClientBucketExt.setBucketAcl
- Defined in exts/bucket.ts:143
Parameters
- params: SetBucketAclParams
- cb: Callback<void>
Returns void

uploadMultipart

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

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

Parameters
- params: UploadMultipartParams
Returns Promise<Part>

part 上传的分片
Inherited from NosClientMultipartUploadExt.uploadMultipart
- 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

Overrides 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

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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: NosClientOptions

Returns NosClient

Properties

options

Methods

Private _request

Parameters

method: string

headers: any

resource: Resource

Optional body: any

Returns Promise<Response>

abortMultipartUpload

Parameters

params: AbortMultipartUploadParams

Returns Promise<boolean>

Parameters

params: AbortMultipartUploadParams

cb: Callback<boolean>

Returns void

completeMultipartUpload

Parameters

params: CompleteMultipartParams

Returns Promise<MultipartUploadObject>

Parameters

params: CompleteMultipartParams

cb: Callback<MultipartUploadObject>

Returns void

copyObject

Parameters

params: CopyObjectParams

Returns Promise<void>

Parameters

params: CopyObjectParams

cb: Callback<void>

Returns void

createToken

Parameters

params: CreateTokenParams

Returns Token

createTokenString

Parameters

params: CreateTokenParams

Returns string

deleteBucket

Parameters

params: OperateBucketParams

Returns Promise<void>

Parameters

params: OperateBucketParams

cb: Callback<void>

Returns void

deleteMultiObject

Parameters

params: DeleteMultiObjectParams

Returns Promise<DeleteMultiObjectErrorInfo[]>

Parameters

params: DeleteMultiObjectParams

cb: Callback<DeleteMultiObjectErrorInfo[]>

Returns void

deleteObject

Parameters

params: DeleteObjectParams

Returns Promise<void>

Parameters

params: DeleteObjectParams

cb: Callback<void>

Returns void

ensureBucket

Parameters

params: PutBucketParams

Returns Promise<void>