Skip to content

Commit

Permalink
Fix #7097 - doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ljian3377 committed Jan 11, 2021
1 parent c81729f commit b1bff1a
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions sdk/storage/storage-file-share/src/Clients.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4712,8 +4712,9 @@ export class ShareFileClient extends StorageClient {
}

/**
* Upload a range of bytes to a file. Both the start and count of the
* range must be specified. The range can be up to 4 MB in size.
* Upload a range of bytes to a file. This operation can only be called on an existing file.
* It won't change the size, properties or metadata of the file.
* Both the start and count of the range must be specified. The range can be up to 4 MB in size.
*
* @param {HttpRequestBody} body Blob, string, ArrayBuffer, ArrayBufferView or a function
* which returns a new Readable stream whose offset is from data source beginning.
Expand Down Expand Up @@ -5035,7 +5036,7 @@ export class ShareFileClient extends StorageClient {
// High Level functions

/**
* Uploads a Buffer(Node)/Blob/ArrayBuffer/ArrayBufferView to an Azure File.
* Creates a new Azure File or replaces an existing Azure File, and then uploads a Buffer(Node)/Blob/ArrayBuffer/ArrayBufferView to it.
*
* @param {Buffer | Blob | ArrayBuffer | ArrayBufferView} data Buffer(Node), Blob, ArrayBuffer or ArrayBufferView
* @param {FileParallelUploadOptions} [options]
Expand Down Expand Up @@ -5124,7 +5125,7 @@ export class ShareFileClient extends StorageClient {
/**
* ONLY AVAILABLE IN NODE.JS RUNTIME.
*
* Uploads a local file to an Azure file.
* Creates a new Azure File or replaces an existing Azure File, and then uploads a local file to it.
*
* @param {string} filePath Full path of local file
* @param {ShareFileClient} fileClient ShareFileClient
Expand Down Expand Up @@ -5452,8 +5453,8 @@ export class ShareFileClient extends StorageClient {
/**
* ONLY AVAILABLE IN NODE.JS RUNTIME.
*
* Uploads a Node.js Readable stream into an Azure file.
* This method will try to create an Azure, then starts uploading chunk by chunk.
* Creates a new Azure File or replaces an existing Azure File, and then uploads a Node.js Readable stream into it.
* This method will try to create an Azure File, then starts uploading chunk by chunk.
* Size of chunk is defined by `bufferSize` parameter.
* Please make sure potential size of stream doesn't exceed file size.
*
Expand Down

0 comments on commit b1bff1a

Please sign in to comment.