NosClientObjectExt | @xgheaven/nos-node-sdk

Hierarchy

NosBaseClient
- NosClientObjectExt
  - NosClient

Index

Constructors

constructor

Properties

options

Methods

Constructors

constructor

new NosClientObjectExt(options: NosClientOptions): NosClientObjectExt

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

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>

copyObject

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

- Defined in exts/object.ts:189
复制对象

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

deleteMultiObject

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

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

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

errors 删除失败的错误列表
- 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

- Defined in exts/object.ts:224
删除对象

Parameters
- params: DeleteObjectParams
Returns Promise<void>
- Defined in exts/object.ts:225
Parameters
- params: DeleteObjectParams
- cb: Callback<void>
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

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

Parameters
- params: GetObjectStreamParams
Returns Promise<ReadableStream>
- Defined in exts/object.ts:110
Parameters
- params: GetObjectBufferParams
Returns Promise<Buffer>
- Defined in exts/object.ts:111
Parameters
- params: GetObjectStringParams
Returns Promise<string>
- Defined in exts/object.ts:112
Parameters
- params: GetObjectStreamParams
- cb: Callback<ReadableStream>
Returns void
- Defined in exts/object.ts:113
Parameters
- params: GetObjectBufferParams
- cb: Callback<Buffer>
Returns void
- 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

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

Parameters
- params: GetObjectUrlParams
Returns Promise<string>
- 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
- Defined in client.ts:81
Parameters
- resp: Response
Returns Promise<Response>

headObject

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

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

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

isObjectExist

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

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

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

listObject

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

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

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

moveObject

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

- Defined in exts/object.ts:243
移动对象

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

putObject

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

- Defined in exts/object.ts:80
上传对象

Parameters
- params: PutObjectParams
Returns Promise<PutObjectResult>
- 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
- 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>

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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: NosClientOptions

Returns NosClientObjectExt

Properties

options

Methods

Private _request

Parameters

method: string

headers: any

resource: Resource

Optional body: any

Returns Promise<Response>

copyObject

Parameters

params: CopyObjectParams

Returns Promise<void>

Parameters

params: CopyObjectParams

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

getObject

Parameters

params: GetObjectStreamParams

Returns Promise<ReadableStream>

Parameters

params: GetObjectBufferParams

Returns Promise<Buffer>

Parameters

params: GetObjectStringParams

Returns Promise<string>

Parameters

params: GetObjectStreamParams

cb: Callback<ReadableStream>

Returns void

Parameters

params: GetObjectBufferParams

cb: Callback<Buffer>

Returns void

Parameters

params: GetObjectStringParams

cb: Callback<string>

Returns void

getObjectUrl

Parameters

params: GetObjectUrlParams

Returns Promise<string>

Parameters

params: GetObjectUrlParams

cb: Callback<string>

Returns void

Protected handleRequestError

Parameters

resp: Response

Returns Promise<Response>

headObject

Parameters