Class Cluster

Hierarchy

Cluster

Index

Constructors

constructor

Methods

Constructors

constructor

new Cluster(options: ClusterOptions): Cluster

- Defined in index.d.ts:606
Parameters
- options: ClusterOptions
Returns Cluster

Methods

copy

copy(name: string, sourceName: string, options?: CopyObjectOptions): Promise<CopyAndPutMetaResult>

- Defined in index.d.ts:626
Parameters
- name: string
- sourceName: string
- Optional options: CopyObjectOptions
Returns Promise<CopyAndPutMetaResult>

delete

delete(name: string, options?: RequestOptions): Promise<NormalSuccessResponse>

- Defined in index.d.ts:624
Parameters
- name: string
- Optional options: RequestOptions
Returns Promise<NormalSuccessResponse>

deleteMulti

deleteMulti(names: string[], options?: DeleteMultiOptions): Promise<DeleteMultiResult>

- Defined in index.d.ts:630
Parameters
- names: string[]
- Optional options: DeleteMultiOptions
Returns Promise<DeleteMultiResult>

get

get(name: string, file?: any, options?: GetObjectOptions): Promise<GetObjectResult>

- Defined in index.d.ts:620
Parameters
- name: string
- Optional file: any
- Optional options: GetObjectOptions
Returns Promise<GetObjectResult>

getStream

getStream(name?: string, options?: GetStreamOptions): Promise<GetStreamResult>

- Defined in index.d.ts:622
Parameters
- Optional name: string
- Optional options: GetStreamOptions
Returns Promise<GetStreamResult>

head

head(name: string, options?: HeadObjectOptions): Promise<HeadObjectResult>

- Defined in index.d.ts:618
Parameters
- name: string
- Optional options: HeadObjectOptions
Returns Promise<HeadObjectResult>

list

list(query: ListObjectsQuery, options: RequestOptions): Promise<ListObjectResult>

- Defined in index.d.ts:608
Parameters
- query: ListObjectsQuery
- options: RequestOptions
Returns Promise<ListObjectResult>

put

put(name: string, file: any, options?: PutObjectOptions): Promise<PutObjectResult>

- Defined in index.d.ts:610
Parameters
- name: string
- file: any
- Optional options: PutObjectOptions
Returns Promise<PutObjectResult>

putACL

putACL(name: string, acl: ACLType, options?: RequestOptions): Promise<NormalSuccessResponse>

- Defined in index.d.ts:634
Parameters
- name: string
- acl: ACLType
- Optional options: RequestOptions
Returns Promise<NormalSuccessResponse>

putMeta

putMeta(name: string, meta: UserMeta, options: RequestOptions): Promise<CopyAndPutMetaResult>

- Defined in index.d.ts:628
Parameters
- name: string
- meta: UserMeta
- options: RequestOptions
Returns Promise<CopyAndPutMetaResult>

putStream

putStream(name: string, stream: any, options?: PutStreamOptions): Promise<{ name: string; res: NormalSuccessResponse }>

- Defined in index.d.ts:612
Parameters
- name: string
- stream: any
- Optional options: PutStreamOptions
Returns Promise<{ name: string; res: NormalSuccessResponse }>

restore

restore(name: string, options?: RequestOptions): Promise<NormalSuccessResponse>

- Defined in index.d.ts:636
Parameters
- name: string
- Optional options: RequestOptions
Returns Promise<NormalSuccessResponse>

signatureUrl

signatureUrl(name: string, options?: SignatureUrlOptions): string

- Defined in index.d.ts:632
Parameters
- name: string
- Optional options: SignatureUrlOptions
Returns string

Generated using TypeDoc