[Storage] Rename options types to be consistent #5650
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jeremymeng
requested review from
HarshaNalluru,
jiacfan,
vinjiang and
XiaoningLiu
as code owners
jeremymeng
added
Client
jeremymeng
commented
Oct 18, 2019
| @@ -565,7 +565,7 @@ export interface UploadToAzureFileOptions extends CommonOptions { | |||
| * If not provided, 5 concurrency will be used by default. | |||
| * | |||
| * @type {number} | |||
| * @memberof UploadToAzureFileOptions | |||
| * @memberof FileParallelUploadOptions | |||
There was a problem hiding this comment.
For types having a concurrency field I add Parallel in their names.
jiacfan
reviewed
Oct 18, 2019
| */ | ||
| progress?: (progress: TransferProgressEvent) => void; | ||
| } | ||
| /** | ||
| * Option interface for BlockBlobClient.uploadFile() and BlockBlobClient.uploadSeekableStream(). | ||
| * | ||
| * @export | ||
| * @interface UploadToBlockBlobOptions | ||
| * @interface BlobDownloadToBufferOptions |
There was a problem hiding this comment.
BlockBlobParallelUploadOptions?
jiacfan
reviewed
Oct 18, 2019
| */ | ||
| abortSignal?: AbortSignalLike; | ||
|
|
||
| /** | ||
| * Destination block blob size in bytes. | ||
| * | ||
| * @type {number} | ||
| * @memberof UploadToBlockBlobOptions | ||
| * @memberof BlobDownloadToBufferOptions |
There was a problem hiding this comment.
BlockBlobParallelUploadOptions and same below in this interface
jiacfan
reviewed
Oct 18, 2019
| @@ -619,15 +619,15 @@ export interface BlobSetTierOptions extends CommonOptions { | |||
| * Option interface for BlobClient.downloadToBuffer(). | |||
| * | |||
| * @export | |||
| * @interface DownloadFromBlobOptions | |||
| * @interface BlobDownloadToBufferOptionsOptions | |||
jiacfan
reviewed
Oct 18, 2019
| /** | ||
| * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. | ||
| * For example, use the @azure/abort-controller to create an `AbortSignal`. | ||
| * | ||
| * @type {AbortSignalLike} | ||
| * @memberof DownloadFromBlobOptions | ||
| * @memberof BlobDownloadToBufferOptionsOptions |
There was a problem hiding this comment.
trivial Options in the end, same below in this interface
jiacfan
reviewed
Oct 18, 2019
| @@ -1457,14 +1457,14 @@ export class BlobClient extends StorageClient { | |||
| * @param {Buffer} buffer Buffer to be fill, must have length larger than count | |||
| * @param {number} offset From which position of the block blob to download(in bytes) | |||
| * @param {number} [count] How much data(in bytes) to be downloaded. Will download to the end when passing undefined | |||
| * @param {DownloadFromBlobOptions} [options] DownloadFromBlobOptions | |||
| * @param {BlobDownloadToBufferOptions} [options] BlobDownloadToBufferOptionsOptions | |||
There was a problem hiding this comment.
Incorrect, trivial Options in the end.
|
alright should be fixed now. |
When the high-level functions were moved into clients, their options type name were not updated. This change renames them to be consistent with other options types. Resolves Azure#5648
jeremymeng
force-pushed
the
consistent-options-name
branch
from
538ef32 to
ea66bf3
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When the high-level functions were moved into clients, their options type name
were not updated. This change renames them to be consistent with other options
types.
Resolves #5648