Class ShareFileClient

Package version

Hierarchy

StorageClient
- ShareFileClient

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new ShareFileClient(url: string, credential: Credential, options: StoragePipelineOptions): ShareFileClient
new ShareFileClient(url: string, pipeline: Pipeline): ShareFileClient

Overrides StorageClient.constructor
- Defined in ShareFileClient.ts:774
Parameters
- url: string
- Optional credential: Credential
- Optional options: StoragePipelineOptions
Returns ShareFileClient
Overrides StorageClient.constructor
- Defined in ShareFileClient.ts:792
Parameters
- url: string
- pipeline: Pipeline
Returns ShareFileClient

Properties

accountName

accountName: string

Protected storageClientContext

storageClientContext: StorageClientContext

url

url: string

Accessors

name

name:

path

path:

shareName

shareName:

Methods

abortCopyFromURL

abortCopyFromURL(copyId: string, options?: FileAbortCopyFromURLOptions): Promise<FileAbortCopyResponse>

- Defined in ShareFileClient.ts:1547
Parameters
- copyId: string
- Default value options: FileAbortCopyFromURLOptions = {}
Returns Promise<FileAbortCopyResponse>

clearRange

clearRange(offset: number, contentLength: number, options?: FileClearRangeOptions): Promise<FileUploadRangeResponse>

- Defined in ShareFileClient.ts:1423
Parameters
- offset: number
- contentLength: number
- Default value options: FileClearRangeOptions = {}
Returns Promise<FileUploadRangeResponse>

create

create(size: number, options?: FileCreateOptions): Promise<FileCreateResponse>

- Defined in ShareFileClient.ts:862
Parameters
- size: number
- Default value options: FileCreateOptions = {}
Returns Promise<FileCreateResponse>

Response data for the File Create operation.

delete

delete(options?: FileDeleteOptions): Promise<FileDeleteResponse>

- Defined in ShareFileClient.ts:1143
Parameters
- Default value options: FileDeleteOptions = {}
Returns Promise<FileDeleteResponse>

Response data for the File Delete operation.

download

download(offset?: number, count: undefined | number, options?: FileDownloadOptions): Promise<FileDownloadResponseModel>

- Defined in ShareFileClient.ts:966
Parameters
- Default value offset: number = 0
- Optional count: undefined | number
- Default value options: FileDownloadOptions = {}
Returns Promise<FileDownloadResponseModel>

Response data for the File Download operation.

downloadToBuffer

downloadToBuffer(buffer: Buffer, offset: undefined | number, count: undefined | number, options: FileDownloadToBufferOptions): Promise<Buffer>
downloadToBuffer(offset: undefined | number, count: undefined | number, options: FileDownloadToBufferOptions): Promise<Buffer>

- Defined in ShareFileClient.ts:1923
Parameters
- buffer: Buffer
- Optional offset: undefined | number
- Optional count: undefined | number
- Optional options: FileDownloadToBufferOptions
Returns Promise<Buffer>
- Defined in ShareFileClient.ts:1945
Parameters
- Optional offset: undefined | number
- Optional count: undefined | number
- Optional options: FileDownloadToBufferOptions
Returns Promise<Buffer>

downloadToFile

downloadToFile(filePath: string, offset?: number, count: undefined | number, options?: FileDownloadOptions): Promise<FileDownloadResponseModel>

- Defined in ShareFileClient.ts:2183
Parameters
- filePath: string
- Default value offset: number = 0
- Optional count: undefined | number
- Default value options: FileDownloadOptions = {}
Returns Promise<FileDownloadResponseModel>

The response data for blob download operation, but with readableStreamBody set to undefined since its content is already read and written into a local file at the specified path.

forceCloseAllHandles

forceCloseAllHandles(options?: FileForceCloseHandlesOptions): Promise<CloseHandlesInfo>

- Defined in ShareFileClient.ts:2402
Parameters
- Default value options: FileForceCloseHandlesOptions = {}
Returns Promise<CloseHandlesInfo>

forceCloseHandle

forceCloseHandle(handleId: string, options?: FileForceCloseHandlesOptions): Promise<FileForceCloseHandlesResponse>

- Defined in ShareFileClient.ts:2446
Parameters
- handleId: string
- Default value options: FileForceCloseHandlesOptions = {}
Returns Promise<FileForceCloseHandlesResponse>

getProperties

getProperties(options?: FileGetPropertiesOptions): Promise<FileGetPropertiesResponse>

- Defined in ShareFileClient.ts:1058
Parameters
- Default value options: FileGetPropertiesOptions = {}
Returns Promise<FileGetPropertiesResponse>

Response data for the File Get Properties operation.

getRangeList

getRangeList(options?: FileGetRangeListOptions): Promise<FileGetRangeListResponse>

- Defined in ShareFileClient.ts:1461
Parameters
- Default value options: FileGetRangeListOptions = {}
Returns Promise<FileGetRangeListResponse>

listHandles

listHandles(options?: FileListHandlesOptions): PagedAsyncIterableIterator<HandleItem, FileListHandlesResponse>

- Defined in ShareFileClient.ts:2322
Parameters
- Default value options: FileListHandlesOptions = {}
Returns PagedAsyncIterableIterator<HandleItem, FileListHandlesResponse>

An asyncIterableIterator that supports paging.

resize

resize(length: number, options?: FileResizeOptions): Promise<FileSetHTTPHeadersResponse>

- Defined in ShareFileClient.ts:1220
Parameters
- length: number
- Default value options: FileResizeOptions = {}
Returns Promise<FileSetHTTPHeadersResponse>

Response data for the File Set HTTP Headers operation.

setHttpHeaders

setHttpHeaders(fileHttpHeaders?: FileHttpHeaders, options?: FileSetHttpHeadersOptions): Promise<FileSetHTTPHeadersResponse>

- Defined in ShareFileClient.ts:1174
Parameters
- Default value fileHttpHeaders: FileHttpHeaders = {}
- Default value options: FileSetHttpHeadersOptions = {}
Returns Promise<FileSetHTTPHeadersResponse>

Response data for the File Set HTTP Headers operation.

setMetadata

setMetadata(metadata?: Metadata, options?: FileSetMetadataOptions): Promise<FileSetMetadataResponse>

- Defined in ShareFileClient.ts:1267
Parameters
- Default value metadata: Metadata = {}
- Default value options: FileSetMetadataOptions = {}
Returns Promise<FileSetMetadataResponse>

Response data for the File Set Metadata operation.

setProperties

setProperties(properties?: FileProperties): Promise<SetPropertiesResponse>

- Defined in ShareFileClient.ts:1092
Parameters
- Default value properties: FileProperties = {}
Returns Promise<SetPropertiesResponse>

startCopyFromURL

startCopyFromURL(copySource: string, options?: FileStartCopyOptions): Promise<FileStartCopyResponse>

- Defined in ShareFileClient.ts:1512
Parameters
- copySource: string
- Default value options: FileStartCopyOptions = {}
Returns Promise<FileStartCopyResponse>

uploadData

uploadData(data: Buffer | Blob | ArrayBuffer | ArrayBufferView, options?: FileParallelUploadOptions): Promise<void>

- Defined in ShareFileClient.ts:1580
Parameters
- data: Buffer | Blob | ArrayBuffer | ArrayBufferView
- Default value options: FileParallelUploadOptions = {}
Returns Promise<void>

uploadFile

uploadFile(filePath: string, options?: FileParallelUploadOptions): Promise<void>

- Defined in ShareFileClient.ts:1708
Parameters
- filePath: string
- Default value options: FileParallelUploadOptions = {}
Returns Promise<void>

uploadRange

uploadRange(body: HttpRequestBody, offset: number, contentLength: number, options?: FileUploadRangeOptions): Promise<FileUploadRangeResponse>

- Defined in ShareFileClient.ts:1316
Parameters
- body: HttpRequestBody
- offset: number
- contentLength: number
- Default value options: FileUploadRangeOptions = {}
Returns Promise<FileUploadRangeResponse>

Response data for the File Upload Range operation.

uploadRangeFromURL

uploadRangeFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: FileUploadRangeFromURLOptions): Promise<FileUploadRangeFromURLResponse>

- Defined in ShareFileClient.ts:1371
Parameters
- sourceURL: string
- sourceOffset: number
- destOffset: number
- count: number
- Default value options: FileUploadRangeFromURLOptions = {}
Returns Promise<FileUploadRangeFromURLResponse>

uploadResetableStream

uploadResetableStream(streamFactory: function, size: number, options?: FileParallelUploadOptions): Promise<void>

- Defined in ShareFileClient.ts:1751
Parameters
- streamFactory: function
  - - (offset: number, count: undefined | number): NodeJS.ReadableStream
    - Parameters
      - offset: number
      - Optional count: undefined | number
      Returns NodeJS.ReadableStream
- size: number
- Default value options: FileParallelUploadOptions = {}
Returns Promise<void>

uploadSeekableBlob

uploadSeekableBlob(blobFactory: function, size: number, options?: FileParallelUploadOptions): Promise<void>

- Defined in ShareFileClient.ts:1627
Parameters
- blobFactory: function
  - - (offset: number, size: number): Blob
    - Parameters
      - offset: number
      - size: number
      Returns Blob
- size: number
- Default value options: FileParallelUploadOptions = {}
Returns Promise<void>

uploadStream

uploadStream(stream: Readable, size: number, bufferSize: number, maxBuffers: number, options?: FileUploadStreamOptions): Promise<void>

- Defined in ShareFileClient.ts:2092
Parameters
- stream: Readable
- size: number
- bufferSize: number
- maxBuffers: number
- Default value options: FileUploadStreamOptions = {}
Returns Promise<void>

Generated using TypeDoc