Class ShareFileClient

Parameters

• copyId: string

  Id of the Copy File operation to abort.

• Default value options: FileAbortCopyFromURLOptions = {}

  Options to File Abort Copy From URL operation.

Returns Promise<FileAbortCopyResponse>

Parameters

• offset: number

  -

• contentLength: number

  -

• Default value options: FileClearRangeOptions = {}

  Options to File Clear Range operation.

Returns Promise<FileUploadRangeResponse>

Parameters

• size: number

  Specifies the maximum size in bytes for the file, up to 4 TB.

• Default value options: FileCreateOptions = {}

  Options to File Create operation.

Returns Promise<FileCreateResponse>

Response data for the File Create operation.

Example usage:

const content = "Hello world!";

// Create the file
await fileClient.create(content.length);
console.log("Created file successfully!");

// Then upload data to the file
await fileClient.uploadRange(content, 0, content.length);
console.log("Updated file successfully!")

Parameters

• Default value options: FileDeleteOptions = {}

  Options to File Delete operation.

Returns Promise<FileDeleteResponse>

Response data for the File Delete operation.

Parameters

• Default value options: FileDeleteOptions = {}

  -

Returns Promise<FileDeleteIfExistsResponse>

Parameters

• Default value offset: number = 0

  From which position of the file to download, greater than or equal to 0

• Optional count: undefined | number

  How much data to be downloaded, greater than 0. Will download to the end when undefined

• Default value options: FileDownloadOptions = {}

  Options to File Download operation.

Returns Promise<FileDownloadResponseModel>

Response data for the File Download operation.

Example usage (Node.js):

// Download a file to a string
const downloadFileResponse = await fileClient.download();
console.log(
  "Downloaded file content:",
  (await streamToBuffer(downloadFileResponse.readableStreamBody)).toString()}
);

// A helper method used to read a Node.js readable stream into string
async function streamToBuffer(readableStream) {
  return new Promise((resolve, reject) => {
    const chunks = [];
    readableStream.on("data", (data) => {
      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

Example usage (browsers):

// Download a file to a string
const downloadFileResponse = await fileClient.download(0);
console.log(
  "Downloaded file content:",
  await blobToString(await downloadFileResponse.blobBody)}
);

// A helper method used to convert a browser Blob into string.
export async function blobToString(blob: Blob): Promise<string> {
  const fileReader = new FileReader();
  return new Promise<string>((resolve, reject) => {
    fileReader.onloadend = (ev: any) => {
      resolve(ev.target!.result);
    };
    fileReader.onerror = reject;
    fileReader.readAsText(blob);
  });
}

Parameters

• buffer: Buffer

  Buffer to be fill, must have length larger than count

• Optional offset: undefined | number

  From which position of the Azure File to download

• Optional count: undefined | number

  How much data to be downloaded. Will download to the end when passing undefined

• Optional options: FileDownloadToBufferOptions

  -

Returns Promise<Buffer>

Parameters

• Optional offset: undefined | number

  From which position of the Azure file to download

• Optional count: undefined | number

  How much data to be downloaded. Will download to the end when passing undefined

• Optional options: FileDownloadToBufferOptions

  -

Returns Promise<Buffer>

Parameters

• filePath: string

  -

• Default value offset: number = 0

  From which position of the block blob to download.

• Optional count: undefined | number

  How much data to be downloaded. Will download to the end when passing undefined.

• Default value options: FileDownloadOptions = {}

  Options to Blob download options.

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.

Parameters

• Default value options: FileExistsOptions = {}

  options to Exists operation.

Returns Promise<boolean>

Parameters

• Default value options: FileForceCloseHandlesOptions = {}

  Options to force close handles operation.

Returns Promise<CloseHandlesInfo>

Parameters

• handleId: string

  Specific handle ID, cannot be asterisk "*". Use forceCloseAllHandles() to close all handles.

• Default value options: FileForceCloseHandlesOptions = {}

Returns Promise<FileForceCloseHandlesResponse>

Parameters

• options: FileGenerateSasUrlOptions

  Optional parameters.

Returns string

The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.

Parameters

• Default value options: FileGetPropertiesOptions = {}

  Options to File Get Properties operation.

Returns Promise<FileGetPropertiesResponse>

Response data for the File Get Properties operation.

Parameters

• Default value options: FileGetRangeListOptions = {}

  Options to File Get range List operation.

Returns Promise<FileGetRangeListResponse>

Parameters

• prevShareSnapshot: string

  The previous snapshot parameter is an opaque DateTime value that specifies the previous share snapshot to compare with.

• Default value options: FileGetRangeListOptions = {}

  -

Returns Promise<FileGetRangeListDiffResponse>

Parameters

• Optional proposeLeaseId: undefined | string

  Initial proposed lease Id.

Returns ShareLeaseClient

A new ShareLeaseClient object for managing leases on the file.

Parameters

• Default value options: FileListHandlesOptions = {}

  Options to list handles operation.

  An asyncIterableIterator that supports paging.

Returns PagedAsyncIterableIterator<HandleItem, FileListHandlesResponse>

Parameters

• length: number

  Resizes a file to the specified size in bytes. If the specified byte value is less than the current size of the file, then all ranges above the specified byte value are cleared.

• Default value options: FileResizeOptions = {}

  Options to File Resize operation.

Returns Promise<FileSetHTTPHeadersResponse>

Response data for the File Set HTTP Headers operation.

Parameters

• Default value fileHttpHeaders: FileHttpHeaders = {}

• Default value options: FileSetHttpHeadersOptions = {}

  Options to File Set HTTP Headers operation.

Returns Promise<FileSetHTTPHeadersResponse>

Response data for the File Set HTTP Headers operation.

Parameters

• Default value metadata: Metadata = {}

  If no metadata provided, all existing directory metadata will be removed

• Default value options: FileSetMetadataOptions = {}

  Options to File Set Metadata operation.

Returns Promise<FileSetMetadataResponse>

Response data for the File Set Metadata operation.

Parameters

• Default value properties: FileProperties = {}

  File properties. For file HTTP headers(e.g. Content-Type), if no values are provided, existing HTTP headers will be removed. For other file properties(e.g. fileAttributes), if no values are provided, existing values will be preserved.

Returns Promise<SetPropertiesResponse>

Parameters

• copySource: string

  Specifies the URL of the source file or blob, up to 2 KB in length. To copy a file to another file within the same storage account, you may use Shared Key to authenticate the source file. If you are copying a file from another storage account, or if you are copying a blob from the same storage account or another storage account, then you must authenticate the source file or blob using a shared access signature. If the source is a public blob, no authentication is required to perform the copy operation. A file in a share snapshot can also be specified as a copy source.

• Default value options: FileStartCopyOptions = {}

  Options to File Start Copy operation.

Returns Promise<FileStartCopyResponse>

Parameters

• data: Buffer | Blob | ArrayBuffer | ArrayBufferView

  Buffer(Node), Blob, ArrayBuffer or ArrayBufferView

• Default value options: FileParallelUploadOptions = {}

  -

Returns Promise<void>

Parameters

• filePath: string

  Full path of local file

• Default value options: FileParallelUploadOptions = {}

  -

Returns Promise<void>

Parameters

• body: HttpRequestBody

  Blob, string, ArrayBuffer, ArrayBufferView or a function which returns a new Readable stream whose offset is from data source beginning.

• offset: number

  Offset position of the destination Azure File to upload.

• contentLength: number

  Length of body in bytes. Use Buffer.byteLength() to calculate body length for a string including non non-Base64/Hex-encoded characters.

• Default value options: FileUploadRangeOptions = {}

  Options to File Upload Range operation.

Returns Promise<FileUploadRangeResponse>

Response data for the File Upload Range operation.

Example usage:

const content = "Hello world!";

// Create the file
await fileClient.create(content.length);
console.log("Created file successfully!");

// Then upload data to the file
await fileClient.uploadRange(content, 0, content.length);
console.log("Updated file successfully!")

Parameters

• sourceURL: string

  Specify a URL to the copy source, Shared Access Signature(SAS) maybe needed for authentication.

• sourceOffset: number

  The source offset to copy from. Pass 0 to copy from the beginning of source file.

• destOffset: number

  Offset of destination file.

• count: number

  Number of bytes to be uploaded from source file.

• Default value options: FileUploadRangeFromURLOptions = {}

  Options to configure File - Upload Range from URL operation.

Returns Promise<FileUploadRangeFromURLResponse>

Parameters

• streamFactory: (offset: number, count?: undefined | number) => NodeJS.ReadableStream

  Returns a Node.js Readable stream starting from the offset defined

  • • (offset: number, count?: undefined | number): NodeJS.ReadableStream

    • Parameters

      • offset: number

      • Optional count: undefined | number

      Returns NodeJS.ReadableStream

• size: number

  Size of the Azure file

• Default value options: FileParallelUploadOptions = {}

  -

Returns Promise<void>

Parameters

• blobFactory: (offset: number, size: number) => Blob

  -

  • • (offset: number, size: number): Blob

    • Parameters

      • offset: number

      • size: number

      Returns Blob

• size: number

  -

• Default value options: FileParallelUploadOptions = {}

  -

Returns Promise<void>

Parameters

• stream: Readable

  Node.js Readable stream. Must be less or equal than file size.

• size: number

  Size of file to be created. Maximum size allowed is 4 TB. If this value is larger than stream size, there will be empty bytes in file tail.

• bufferSize: number

  Size of every buffer allocated in bytes, also the chunk/range size during the uploaded file. Size must be greater than 0 and lesser than or equal to 4 * 1024 * 1024 (4MB)

• maxBuffers: number

  Max buffers will allocate during uploading, positive correlation with max uploading concurrency

• Default value options: FileUploadStreamOptions = {}

  -

Returns Promise<void>

Parameters

• shareSnapshot: string

  The share snapshot timestamp.

Returns ShareFileClient

A new ShareFileClient object identical to the source but with the specified share snapshot timestamp.