From 5d44e7afc898b2a198e668593e545eab36678ecf Mon Sep 17 00:00:00 2001 From: Jeremy Meng Date: Thu, 16 May 2019 05:08:11 +0000 Subject: [PATCH] [Blob] Remove I prefix from interface names --- .../storage-blob/src/AccountSASPermissions.ts | 4 +- .../src/AccountSASResourceTypes.ts | 2 +- .../storage-blob/src/AccountSASServices.ts | 2 +- ...Values.ts => AccountSASSignatureValues.ts} | 32 ++--- .../storage-blob/src/AppendBlobClient.ts | 20 ++-- sdk/storage/storage-blob/src/BlobClient.ts | 112 +++++++++--------- .../storage-blob/src/BlobDownloadResponse.ts | 12 +- .../storage-blob/src/BlobSASPermissions.ts | 2 +- ...ureValues.ts => BlobSASSignatureValues.ts} | 44 +++---- .../storage-blob/src/BlockBlobClient.ts | 44 +++---- .../storage-blob/src/ContainerClient.ts | 94 +++++++-------- .../src/ContainerSASPermissions.ts | 2 +- .../src/{IIPRange.ts => IPRange.ts} | 8 +- .../storage-blob/src/LoggingPolicyFactory.ts | 10 +- .../storage-blob/src/PageBlobClient.ts | 68 +++++------ sdk/storage/storage-blob/src/Pipeline.ts | 10 +- .../storage-blob/src/{IRange.ts => Range.ts} | 16 +-- .../storage-blob/src/RetryPolicyFactory.ts | 20 ++-- .../storage-blob/src/SASQueryParameters.ts | 20 ++-- sdk/storage/storage-blob/src/ServiceClient.ts | 6 +- sdk/storage/storage-blob/src/StorageClient.ts | 20 ++-- .../src/TelemetryPolicyFactory.ts | 8 +- .../storage-blob/src/highlevel.browser.ts | 10 +- .../storage-blob/src/highlevel.common.ts | 42 +++---- .../storage-blob/src/highlevel.node.ts | 38 +++--- sdk/storage/storage-blob/src/index.browser.ts | 4 +- sdk/storage/storage-blob/src/index.ts | 8 +- sdk/storage/storage-blob/src/models.ts | 10 +- .../src/policies/LoggingPolicy.ts | 12 +- .../storage-blob/src/policies/RetryPolicy.ts | 18 +-- .../src/policies/TelemetryPolicy.ts | 2 +- .../src/utils/RetriableReadableStream.ts | 14 +-- .../test/node/highlevel.node.spec.ts | 12 +- .../storage-blob/test/utils/InjectorPolicy.ts | 2 +- sdk/storage/storage-blob/tslint.json | 3 +- 35 files changed, 366 insertions(+), 365 deletions(-) rename sdk/storage/storage-blob/src/{IAccountSASSignatureValues.ts => AccountSASSignatureValues.ts} (85%) rename sdk/storage/storage-blob/src/{IBlobSASSignatureValues.ts => BlobSASSignatureValues.ts} (87%) rename sdk/storage/storage-blob/src/{IIPRange.ts => IPRange.ts} (81%) rename sdk/storage/storage-blob/src/{IRange.ts => Range.ts} (70%) diff --git a/sdk/storage/storage-blob/src/AccountSASPermissions.ts b/sdk/storage/storage-blob/src/AccountSASPermissions.ts index f2fa068aef10..8b8c18d37d37 100644 --- a/sdk/storage/storage-blob/src/AccountSASPermissions.ts +++ b/sdk/storage/storage-blob/src/AccountSASPermissions.ts @@ -4,7 +4,7 @@ * This is a helper class to construct a string representing the permissions granted by an AccountSAS. Setting a value * to true means that any SAS which uses these permissions will grant permissions for that operation. Once all the * values are set, this should be serialized with toString and set as the permissions field on an - * {@link IAccountSASSignatureValues} object. It is possible to construct the permissions string without this class, but + * {@link AccountSASSignatureValues} object. It is possible to construct the permissions string without this class, but * the order of the permissions is particular and this class guarantees correctness. * * @export @@ -122,7 +122,7 @@ export class AccountSASPermissions { /** * Produces the SAS permissions string for an Azure Storage account. - * Call this method to set IAccountSASSignatureValues Permissions field. + * Call this method to set AccountSASSignatureValues Permissions field. * * Using this method will guarantee the resource types are in * an order accepted by the service. diff --git a/sdk/storage/storage-blob/src/AccountSASResourceTypes.ts b/sdk/storage/storage-blob/src/AccountSASResourceTypes.ts index 4c2f35bb256d..d98715edbbdf 100644 --- a/sdk/storage/storage-blob/src/AccountSASResourceTypes.ts +++ b/sdk/storage/storage-blob/src/AccountSASResourceTypes.ts @@ -4,7 +4,7 @@ * This is a helper class to construct a string representing the resources accessible by an AccountSAS. Setting a value * to true means that any SAS which uses these permissions will grant access to that resource type. Once all the * values are set, this should be serialized with toString and set as the resources field on an - * {@link IAccountSASSignatureValues} object. It is possible to construct the resources string without this class, but + * {@link AccountSASSignatureValues} object. It is possible to construct the resources string without this class, but * the order of the resources is particular and this class guarantees correctness. * * @export diff --git a/sdk/storage/storage-blob/src/AccountSASServices.ts b/sdk/storage/storage-blob/src/AccountSASServices.ts index 60d43e0a2db8..1dc9f5e974ac 100644 --- a/sdk/storage/storage-blob/src/AccountSASServices.ts +++ b/sdk/storage/storage-blob/src/AccountSASServices.ts @@ -4,7 +4,7 @@ * This is a helper class to construct a string representing the services accessible by an AccountSAS. Setting a value * to true means that any SAS which uses these permissions will grant access to that service. Once all the * values are set, this should be serialized with toString and set as the services field on an - * {@link IAccountSASSignatureValues} object. It is possible to construct the services string without this class, but + * {@link AccountSASSignatureValues} object. It is possible to construct the services string without this class, but * the order of the services is particular and this class guarantees correctness. * * @export diff --git a/sdk/storage/storage-blob/src/IAccountSASSignatureValues.ts b/sdk/storage/storage-blob/src/AccountSASSignatureValues.ts similarity index 85% rename from sdk/storage/storage-blob/src/IAccountSASSignatureValues.ts rename to sdk/storage/storage-blob/src/AccountSASSignatureValues.ts index e438caf5ceaf..bca5e7ef9251 100644 --- a/sdk/storage/storage-blob/src/IAccountSASSignatureValues.ts +++ b/sdk/storage/storage-blob/src/AccountSASSignatureValues.ts @@ -2,7 +2,7 @@ import { AccountSASPermissions } from "./AccountSASPermissions"; import { AccountSASResourceTypes } from "./AccountSASResourceTypes"; import { AccountSASServices } from "./AccountSASServices"; import { SharedKeyCredential } from "./credentials/SharedKeyCredential"; -import { IIPRange, ipRangeToString } from "./IIPRange"; +import { IPRange, ipRangeToString } from "./IPRange"; import { SASProtocol, SASQueryParameters } from "./SASQueryParameters"; import { SERVICE_VERSION } from "./utils/constants"; import { truncatedISO8061Date } from "./utils/utils.common"; @@ -10,7 +10,7 @@ import { truncatedISO8061Date } from "./utils/utils.common"; /** * ONLY AVAILABLE IN NODE.JS RUNTIME. * - * IAccountSASSignatureValues is used to generate a Shared Access Signature (SAS) for an Azure Storage account. Once + * AccountSASSignatureValues is used to generate a Shared Access Signature (SAS) for an Azure Storage account. Once * all the values here are set appropriately, call generateSASQueryParameters() to obtain a representation of the SAS * which can actually be applied to blob urls. Note: that both this class and {@link SASQueryParameters} exist because * the former is mutable and a logical representation while the latter is immutable and used to generate actual REST @@ -23,14 +23,14 @@ import { truncatedISO8061Date } from "./utils/utils.common"; * for descriptions of the parameters, including which are required * * @export - * @class IAccountSASSignatureValues + * @class AccountSASSignatureValues */ -export interface IAccountSASSignatureValues { +export interface AccountSASSignatureValues { /** * If not provided, this defaults to the service version targeted by this version of the library. * * @type {string} - * @memberof IAccountSASSignatureValues + * @memberof AccountSASSignatureValues */ version?: string; @@ -38,7 +38,7 @@ export interface IAccountSASSignatureValues { * Optional. SAS protocols allowed. * * @type {SASProtocol} - * @memberof IAccountSASSignatureValues + * @memberof AccountSASSignatureValues */ protocol?: SASProtocol; @@ -46,7 +46,7 @@ export interface IAccountSASSignatureValues { * Optional. When the SAS will take effect. * * @type {Date} - * @memberof IAccountSASSignatureValues + * @memberof AccountSASSignatureValues */ startTime?: Date; @@ -54,7 +54,7 @@ export interface IAccountSASSignatureValues { * The time after which the SAS will no longer work. * * @type {Date} - * @memberof IAccountSASSignatureValues + * @memberof AccountSASSignatureValues */ expiryTime: Date; @@ -63,24 +63,24 @@ export interface IAccountSASSignatureValues { * constructing the permissions string. * * @type {string} - * @memberof IAccountSASSignatureValues + * @memberof AccountSASSignatureValues */ permissions: string; /** * Optional. IP range allowed. * - * @type {IIPRange} - * @memberof IAccountSASSignatureValues + * @type {IPRange} + * @memberof AccountSASSignatureValues */ - ipRange?: IIPRange; + ipRange?: IPRange; /** * The values that indicate the services accessible with this SAS. Please refer to {@link AccountSASServices} to * construct this value. * * @type {string} - * @memberof IAccountSASSignatureValues + * @memberof AccountSASSignatureValues */ services: string; @@ -89,7 +89,7 @@ export interface IAccountSASSignatureValues { * to {@link AccountSASResourceTypes} to construct this value. * * @type {string} - * @memberof IAccountSASSignatureValues + * @memberof AccountSASSignatureValues */ resourceTypes: string; } @@ -104,10 +104,10 @@ export interface IAccountSASSignatureValues { * * @param {SharedKeyCredential} sharedKeyCredential * @returns {SASQueryParameters} - * @memberof IAccountSASSignatureValues + * @memberof AccountSASSignatureValues */ export function generateAccountSASQueryParameters( - accountSASSignatureValues: IAccountSASSignatureValues, + accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: SharedKeyCredential ): SASQueryParameters { const version = accountSASSignatureValues.version diff --git a/sdk/storage/storage-blob/src/AppendBlobClient.ts b/sdk/storage/storage-blob/src/AppendBlobClient.ts index bac431bc2219..5a56542fbc2a 100644 --- a/sdk/storage/storage-blob/src/AppendBlobClient.ts +++ b/sdk/storage/storage-blob/src/AppendBlobClient.ts @@ -5,19 +5,19 @@ import { Aborter } from "./Aborter"; import { BlobClient } from "./BlobClient"; import { ContainerClient } from "./ContainerClient"; import { AppendBlob } from "./generated/lib/operations"; -import { IAppendBlobAccessConditions, IBlobAccessConditions, IMetadata } from "./models"; +import { AppendBlobAccessConditions, BlobAccessConditions, Metadata } from "./models"; import { Pipeline } from "./Pipeline"; import { URLConstants } from "./utils/constants"; import { appendToURLPath, setURLParameter } from "./utils/utils.common"; -export interface IAppendBlobCreateOptions { - accessConditions?: IBlobAccessConditions; +export interface AppendBlobCreateOptions { + accessConditions?: BlobAccessConditions; blobHTTPHeaders?: Models.BlobHTTPHeaders; - metadata?: IMetadata; + metadata?: Metadata; } -export interface IAppendBlobAppendBlockOptions { - accessConditions?: IAppendBlobAccessConditions; +export interface AppendBlobAppendBlockOptions { + accessConditions?: AppendBlobAccessConditions; progress?: (progress: TransferProgressEvent) => void; transactionalContentMD5?: Uint8Array; } @@ -131,13 +131,13 @@ export class AppendBlobClient extends BlobClient { * * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(), * goto documents of Aborter for more examples about request cancellation - * @param {IAppendBlobCreateOptions} [options] + * @param {AppendBlobCreateOptions} [options] * @returns {Promise} * @memberof AppendBlobClient */ public async create( aborter: Aborter, - options: IAppendBlobCreateOptions = {} + options: AppendBlobCreateOptions = {} ): Promise { options.accessConditions = options.accessConditions || {}; return this.appendBlobContext.create(0, { @@ -157,7 +157,7 @@ export class AppendBlobClient extends BlobClient { * goto documents of Aborter for more examples about request cancellation * @param {HttpRequestBody} body * @param {number} contentLength - * @param {IAppendBlobAppendBlockOptions} [options] + * @param {AppendBlobAppendBlockOptions} [options] * @returns {Promise} * @memberof AppendBlobClient */ @@ -165,7 +165,7 @@ export class AppendBlobClient extends BlobClient { aborter: Aborter, body: HttpRequestBody, contentLength: number, - options: IAppendBlobAppendBlockOptions = {} + options: AppendBlobAppendBlockOptions = {} ): Promise { options.accessConditions = options.accessConditions || {}; return this.appendBlobContext.appendBlock(body, contentLength, { diff --git a/sdk/storage/storage-blob/src/BlobClient.ts b/sdk/storage/storage-blob/src/BlobClient.ts index 78a63365b6ca..296abb1cb015 100644 --- a/sdk/storage/storage-blob/src/BlobClient.ts +++ b/sdk/storage/storage-blob/src/BlobClient.ts @@ -5,17 +5,17 @@ import { Aborter } from "./Aborter"; import { BlobDownloadResponse } from "./BlobDownloadResponse"; import { ContainerClient } from "./ContainerClient"; import { Blob } from "./generated/lib/operations"; -import { rangeToString } from "./IRange"; -import { IBlobAccessConditions, IMetadata } from "./models"; +import { rangeToString } from "./Range"; +import { BlobAccessConditions, Metadata } from "./models"; import { Pipeline } from "./Pipeline"; import { StorageClient } from "./StorageClient"; import { DEFAULT_MAX_DOWNLOAD_RETRY_REQUESTS, URLConstants } from "./utils/constants"; import { appendToURLPath, setURLParameter } from "./utils/utils.common"; -export interface IBlobDownloadOptions { +export interface BlobDownloadOptions { snapshot?: string; rangeGetContentMD5?: boolean; - blobAccessConditions?: IBlobAccessConditions; + blobAccessConditions?: BlobAccessConditions; progress?: (progress: TransferProgressEvent) => void; /** @@ -31,64 +31,64 @@ export interface IBlobDownloadOptions { * Default value is 5, please set a larger value when loading large files in poor network. * * @type {number} - * @memberof IBlobDownloadOptions + * @memberof BlobDownloadOptions */ maxRetryRequests?: number; } -export interface IBlobGetPropertiesOptions { - blobAccessConditions?: IBlobAccessConditions; +export interface BlobGetPropertiesOptions { + blobAccessConditions?: BlobAccessConditions; } -export interface IBlobDeleteOptions { - blobAccessConditions?: IBlobAccessConditions; +export interface BlobDeleteOptions { + blobAccessConditions?: BlobAccessConditions; deleteSnapshots?: Models.DeleteSnapshotsOptionType; } -export interface IBlobSetHTTPHeadersOptions { - blobAccessConditions?: IBlobAccessConditions; +export interface BlobSetHTTPHeadersOptions { + blobAccessConditions?: BlobAccessConditions; } -export interface IBlobSetMetadataOptions { - blobAccessConditions?: IBlobAccessConditions; +export interface BlobSetMetadataOptions { + blobAccessConditions?: BlobAccessConditions; } -export interface IBlobAcquireLeaseOptions { +export interface BlobAcquireLeaseOptions { modifiedAccessConditions?: Models.ModifiedAccessConditions; } -export interface IBlobReleaseLeaseOptions { +export interface BlobReleaseLeaseOptions { modifiedAccessConditions?: Models.ModifiedAccessConditions; } -export interface IBlobRenewLeaseOptions { +export interface BlobRenewLeaseOptions { modifiedAccessConditions?: Models.ModifiedAccessConditions; } -export interface IBlobChangeLeaseOptions { +export interface BlobChangeLeaseOptions { modifiedAccessConditions?: Models.ModifiedAccessConditions; } -export interface IBlobBreakLeaseOptions { +export interface BlobBreakLeaseOptions { modifiedAccessConditions?: Models.ModifiedAccessConditions; } -export interface IBlobCreateSnapshotOptions { - metadata?: IMetadata; - blobAccessConditions?: IBlobAccessConditions; +export interface BlobCreateSnapshotOptions { + metadata?: Metadata; + blobAccessConditions?: BlobAccessConditions; } -export interface IBlobStartCopyFromURLOptions { - metadata?: IMetadata; - blobAccessConditions?: IBlobAccessConditions; +export interface BlobStartCopyFromURLOptions { + metadata?: Metadata; + blobAccessConditions?: BlobAccessConditions; sourceModifiedAccessConditions?: Models.ModifiedAccessConditions; } -export interface IBlobAbortCopyFromURLOptions { +export interface BlobAbortCopyFromURLOptions { leaseAccessConditions?: Models.LeaseAccessConditions; } -export interface IBlobSetTierOptions { +export interface BlobSetTierOptions { leaseAccessConditions?: Models.LeaseAccessConditions; } @@ -193,7 +193,7 @@ export class BlobClient extends StorageClient { * goto documents of Aborter for more examples about request cancellation * @param {number} offset From which position of the blob to download, >= 0 * @param {number} [count] How much data to be downloaded, > 0. Will download to the end when undefined - * @param {IBlobDownloadOptions} [options] + * @param {BlobDownloadOptions} [options] * @returns {Promise} * @memberof BlobClient */ @@ -201,7 +201,7 @@ export class BlobClient extends StorageClient { aborter: Aborter, offset: number, count?: number, - options: IBlobDownloadOptions = {} + options: BlobDownloadOptions = {} ): Promise { options.blobAccessConditions = options.blobAccessConditions || {}; options.blobAccessConditions.modifiedAccessConditions = @@ -289,13 +289,13 @@ export class BlobClient extends StorageClient { * * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(), * goto documents of Aborter for more examples about request cancellation - * @param {IBlobGetPropertiesOptions} [options] + * @param {BlobGetPropertiesOptions} [options] * @returns {Promise} * @memberof BlobClient */ public async getProperties( aborter: Aborter, - options: IBlobGetPropertiesOptions = {} + options: BlobGetPropertiesOptions = {} ): Promise { options.blobAccessConditions = options.blobAccessConditions || {}; return this.blobContext.getProperties({ @@ -314,13 +314,13 @@ export class BlobClient extends StorageClient { * * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(), * goto documents of Aborter for more examples about request cancellation - * @param {IBlobDeleteOptions} [options] + * @param {BlobDeleteOptions} [options] * @returns {Promise} * @memberof BlobClient */ public async delete( aborter: Aborter, - options: IBlobDeleteOptions = {} + options: BlobDeleteOptions = {} ): Promise { options.blobAccessConditions = options.blobAccessConditions || {}; return this.blobContext.deleteMethod({ @@ -360,14 +360,14 @@ export class BlobClient extends StorageClient { * @param {Models.BlobHTTPHeaders} [blobHTTPHeaders] If no value provided, or no value provided for * the specificed blob HTTP headers, these blob HTTP * headers without a value will be cleared. - * @param {IBlobSetHTTPHeadersOptions} [options] + * @param {BlobSetHTTPHeadersOptions} [options] * @returns {Promise} * @memberof BlobClient */ public async setHTTPHeaders( aborter: Aborter, blobHTTPHeaders?: Models.BlobHTTPHeaders, - options: IBlobSetHTTPHeadersOptions = {} + options: BlobSetHTTPHeadersOptions = {} ): Promise { options.blobAccessConditions = options.blobAccessConditions || {}; return this.blobContext.setHTTPHeaders({ @@ -387,16 +387,16 @@ export class BlobClient extends StorageClient { * * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(), * goto documents of Aborter for more examples about request cancellation - * @param {IMetadata} [metadata] Replace existing metadata with this value. + * @param {Metadata} [metadata] Replace existing metadata with this value. * If no value provided the existing metadata will be removed. - * @param {IBlobSetMetadataOptions} [options] + * @param {BlobSetMetadataOptions} [options] * @returns {Promise} * @memberof BlobClient */ public async setMetadata( aborter: Aborter, - metadata?: IMetadata, - options: IBlobSetMetadataOptions = {} + metadata?: Metadata, + options: BlobSetMetadataOptions = {} ): Promise { options.blobAccessConditions = options.blobAccessConditions || {}; return this.blobContext.setMetadata({ @@ -417,7 +417,7 @@ export class BlobClient extends StorageClient { * goto documents of Aborter for more examples about request cancellation * @param {string} proposedLeaseId Can be specified in any valid GUID string format * @param {number} duration The lock duration can be 15 to 60 seconds, or can be infinite - * @param {IBlobAcquireLeaseOptions} [options] + * @param {BlobAcquireLeaseOptions} [options] * @returns {Promise} * @memberof BlobClient */ @@ -425,7 +425,7 @@ export class BlobClient extends StorageClient { aborter: Aborter, proposedLeaseId: string, duration: number, - options: IBlobAcquireLeaseOptions = {} + options: BlobAcquireLeaseOptions = {} ): Promise { return this.blobContext.acquireLease({ abortSignal: aborter, @@ -443,14 +443,14 @@ export class BlobClient extends StorageClient { * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(), * goto documents of Aborter for more examples about request cancellation * @param {string} leaseId - * @param {IBlobReleaseLeaseOptions} [options] + * @param {BlobReleaseLeaseOptions} [options] * @returns {Promise} * @memberof BlobClient */ public async releaseLease( aborter: Aborter, leaseId: string, - options: IBlobReleaseLeaseOptions = {} + options: BlobReleaseLeaseOptions = {} ): Promise { return this.blobContext.releaseLease(leaseId, { abortSignal: aborter, @@ -465,14 +465,14 @@ export class BlobClient extends StorageClient { * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(), * goto documents of Aborter for more examples about request cancellation * @param {string} leaseId - * @param {IBlobRenewLeaseOptions} [options] + * @param {BlobRenewLeaseOptions} [options] * @returns {Promise} * @memberof BlobClient */ public async renewLease( aborter: Aborter, leaseId: string, - options: IBlobRenewLeaseOptions = {} + options: BlobRenewLeaseOptions = {} ): Promise { return this.blobContext.renewLease(leaseId, { abortSignal: aborter, @@ -488,7 +488,7 @@ export class BlobClient extends StorageClient { * goto documents of Aborter for more examples about request cancellation * @param {string} leaseId * @param {string} proposedLeaseId - * @param {IBlobChangeLeaseOptions} [options] + * @param {BlobChangeLeaseOptions} [options] * @returns {Promise} * @memberof BlobClient */ @@ -496,7 +496,7 @@ export class BlobClient extends StorageClient { aborter: Aborter, leaseId: string, proposedLeaseId: string, - options: IBlobChangeLeaseOptions = {} + options: BlobChangeLeaseOptions = {} ): Promise { return this.blobContext.changeLease(leaseId, proposedLeaseId, { abortSignal: aborter, @@ -512,14 +512,14 @@ export class BlobClient extends StorageClient { * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(), * goto documents of Aborter for more examples about request cancellation * @param {number} [breakPeriod] - * @param {IBlobBreakLeaseOptions} [options] + * @param {BlobBreakLeaseOptions} [options] * @returns {Promise} * @memberof BlobClient */ public async breakLease( aborter: Aborter, breakPeriod?: number, - options: IBlobBreakLeaseOptions = {} + options: BlobBreakLeaseOptions = {} ): Promise { return this.blobContext.breakLease({ abortSignal: aborter, @@ -534,13 +534,13 @@ export class BlobClient extends StorageClient { * * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(), * goto documents of Aborter for more examples about request cancellation - * @param {IBlobCreateSnapshotOptions} [options] + * @param {BlobCreateSnapshotOptions} [options] * @returns {Promise} * @memberof BlobClient */ public async createSnapshot( aborter: Aborter, - options: IBlobCreateSnapshotOptions = {} + options: BlobCreateSnapshotOptions = {} ): Promise { options.blobAccessConditions = options.blobAccessConditions || {}; return this.blobContext.createSnapshot({ @@ -564,14 +564,14 @@ export class BlobClient extends StorageClient { * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(), * goto documents of Aborter for more examples about request cancellation * @param {string} copySource - * @param {IBlobStartCopyFromURLOptions} [options] + * @param {BlobStartCopyFromURLOptions} [options] * @returns {Promise} * @memberof BlobClient */ public async startCopyFromURL( aborter: Aborter, copySource: string, - options: IBlobStartCopyFromURLOptions = {} + options: BlobStartCopyFromURLOptions = {} ): Promise { options.blobAccessConditions = options.blobAccessConditions || {}; options.sourceModifiedAccessConditions = options.sourceModifiedAccessConditions || {}; @@ -598,14 +598,14 @@ export class BlobClient extends StorageClient { * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(), * goto documents of Aborter for more examples about request cancellation * @param {string} copyId - * @param {IBlobAbortCopyFromURLOptions} [options] + * @param {BlobAbortCopyFromURLOptions} [options] * @returns {Promise} * @memberof BlobClient */ public async abortCopyFromURL( aborter: Aborter, copyId: string, - options: IBlobAbortCopyFromURLOptions = {} + options: BlobAbortCopyFromURLOptions = {} ): Promise { return this.blobContext.abortCopyFromURL(copyId, { abortSignal: aborter, @@ -624,14 +624,14 @@ export class BlobClient extends StorageClient { * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(), * goto documents of Aborter for more examples about request cancellation * @param {Models.AccessTier} tier - * @param {IBlobSetTierOptions} [options] + * @param {BlobSetTierOptions} [options] * @returns {Promise} * @memberof BlobClient */ public async setTier( aborter: Aborter, tier: Models.AccessTier, - options: IBlobSetTierOptions = {} + options: BlobSetTierOptions = {} ): Promise { return await this.blobContext.setTier(tier, { abortSignal: aborter, diff --git a/sdk/storage/storage-blob/src/BlobDownloadResponse.ts b/sdk/storage/storage-blob/src/BlobDownloadResponse.ts index 0a62dc183f4c..d0159d3c2af6 100644 --- a/sdk/storage/storage-blob/src/BlobDownloadResponse.ts +++ b/sdk/storage/storage-blob/src/BlobDownloadResponse.ts @@ -2,8 +2,8 @@ import { HttpResponse, isNode } from "@azure/ms-rest-js"; import { Aborter } from "./Aborter"; import * as Models from "./generated/lib/models"; -import { IMetadata } from "./models"; -import { IRetriableReadableStreamOptions } from "./utils/RetriableReadableStream"; +import { Metadata } from "./models"; +import { RetriableReadableStreamOptions } from "./utils/RetriableReadableStream"; import { ReadableStreamGetter, RetriableReadableStream } from "./utils/RetriableReadableStream"; /** @@ -364,10 +364,10 @@ export class BlobDownloadResponse implements Models.BlobDownloadResponse { * to associate with a file storage object. * * @readonly - * @type {(IMetadata | undefined)} + * @type {(Metadata | undefined)} * @memberof BlobDownloadResponse */ - public get metadata(): IMetadata | undefined { + public get metadata(): Metadata | undefined { return this.originalResponse.metadata; } @@ -438,7 +438,7 @@ export class BlobDownloadResponse implements Models.BlobDownloadResponse { * @param {ReadableStreamGetter} getter * @param {number} offset * @param {number} count - * @param {IRetriableReadableStreamOptions} [options={}] + * @param {RetriableReadableStreamOptions} [options={}] * @memberof BlobDownloadResponse */ public constructor( @@ -447,7 +447,7 @@ export class BlobDownloadResponse implements Models.BlobDownloadResponse { getter: ReadableStreamGetter, offset: number, count: number, - options: IRetriableReadableStreamOptions = {} + options: RetriableReadableStreamOptions = {} ) { this.originalResponse = originalResponse; this.blobDownloadStream = new RetriableReadableStream( diff --git a/sdk/storage/storage-blob/src/BlobSASPermissions.ts b/sdk/storage/storage-blob/src/BlobSASPermissions.ts index 00fa4082a478..cd463f996527 100644 --- a/sdk/storage/storage-blob/src/BlobSASPermissions.ts +++ b/sdk/storage/storage-blob/src/BlobSASPermissions.ts @@ -4,7 +4,7 @@ * This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a blob. Setting * a value to true means that any SAS which uses these permissions will grant permissions for that operation. Once all * the values are set, this should be serialized with toString and set as the permissions field on a - * {@link IBlobSASSignatureValues} object. It is possible to construct the permissions string without this class, but + * {@link BlobSASSignatureValues} object. It is possible to construct the permissions string without this class, but * the order of the permissions is particular and this class guarantees correctness. * * @export diff --git a/sdk/storage/storage-blob/src/IBlobSASSignatureValues.ts b/sdk/storage/storage-blob/src/BlobSASSignatureValues.ts similarity index 87% rename from sdk/storage/storage-blob/src/IBlobSASSignatureValues.ts rename to sdk/storage/storage-blob/src/BlobSASSignatureValues.ts index 204bc86fa21b..efc825b4d4bc 100644 --- a/sdk/storage/storage-blob/src/IBlobSASSignatureValues.ts +++ b/sdk/storage/storage-blob/src/BlobSASSignatureValues.ts @@ -1,7 +1,7 @@ import { BlobSASPermissions } from "./BlobSASPermissions"; import { ContainerSASPermissions } from "./ContainerSASPermissions"; import { SharedKeyCredential } from "./credentials/SharedKeyCredential"; -import { IIPRange, ipRangeToString } from "./IIPRange"; +import { IPRange, ipRangeToString } from "./IPRange"; import { SASProtocol } from "./SASQueryParameters"; import { SASQueryParameters } from "./SASQueryParameters"; import { SERVICE_VERSION } from "./utils/constants"; @@ -10,18 +10,18 @@ import { truncatedISO8061Date } from "./utils/utils.common"; /** * ONLY AVAILABLE IN NODE.JS RUNTIME. * - * IBlobSASSignatureValues is used to help generating Blob service SAS tokens for containers or blobs. + * BlobSASSignatureValues is used to help generating Blob service SAS tokens for containers or blobs. * * @export - * @class IBlobSASSignatureValues + * @class BlobSASSignatureValues */ -export interface IBlobSASSignatureValues { +export interface BlobSASSignatureValues { /** * The version of the service this SAS will target. If not specified, it will default to the version targeted by the * library. * * @type {string} - * @memberof IBlobSASSignatureValues + * @memberof BlobSASSignatureValues */ version?: string; @@ -29,7 +29,7 @@ export interface IBlobSASSignatureValues { * Optional. SAS protocols, HTTPS only or HTTPSandHTTP * * @type {SASProtocol} - * @memberof IBlobSASSignatureValues + * @memberof BlobSASSignatureValues */ protocol?: SASProtocol; @@ -37,7 +37,7 @@ export interface IBlobSASSignatureValues { * Optional. When the SAS will take effect. * * @type {Date} - * @memberof IBlobSASSignatureValues + * @memberof BlobSASSignatureValues */ startTime?: Date; @@ -45,7 +45,7 @@ export interface IBlobSASSignatureValues { * Optional only when identifier is provided. The time after which the SAS will no longer work. * * @type {Date} - * @memberof IBlobSASSignatureValues + * @memberof BlobSASSignatureValues */ expiryTime?: Date; @@ -55,23 +55,23 @@ export interface IBlobSASSignatureValues { * being accessed for help constructing the permissions string. * * @type {string} - * @memberof IBlobSASSignatureValues + * @memberof BlobSASSignatureValues */ permissions?: string; /** * Optional. IP ranges allowed in this SAS. * - * @type {IIPRange} - * @memberof IBlobSASSignatureValues + * @type {IPRange} + * @memberof BlobSASSignatureValues */ - ipRange?: IIPRange; + ipRange?: IPRange; /** * The name of the container the SAS user may access. * * @type {string} - * @memberof IBlobSASSignatureValues + * @memberof BlobSASSignatureValues */ containerName: string; @@ -79,7 +79,7 @@ export interface IBlobSASSignatureValues { * Optional. The name of the container the SAS user may access. * * @type {string} - * @memberof IBlobSASSignatureValues + * @memberof BlobSASSignatureValues */ blobName?: string; @@ -89,7 +89,7 @@ export interface IBlobSASSignatureValues { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy * * @type {string} - * @memberof IBlobSASSignatureValues + * @memberof BlobSASSignatureValues */ identifier?: string; @@ -97,7 +97,7 @@ export interface IBlobSASSignatureValues { * Optional. The cache-control header for the SAS. * * @type {string} - * @memberof IBlobSASSignatureValues + * @memberof BlobSASSignatureValues */ cacheControl?: string; @@ -105,7 +105,7 @@ export interface IBlobSASSignatureValues { * Optional. The content-disposition header for the SAS. * * @type {string} - * @memberof IBlobSASSignatureValues + * @memberof BlobSASSignatureValues */ contentDisposition?: string; @@ -113,7 +113,7 @@ export interface IBlobSASSignatureValues { * Optional. The content-encoding header for the SAS. * * @type {string} - * @memberof IBlobSASSignatureValues + * @memberof BlobSASSignatureValues */ contentEncoding?: string; @@ -121,7 +121,7 @@ export interface IBlobSASSignatureValues { * Optional. The content-language header for the SAS. * * @type {string} - * @memberof IBlobSASSignatureValues + * @memberof BlobSASSignatureValues */ contentLanguage?: string; @@ -129,7 +129,7 @@ export interface IBlobSASSignatureValues { * Optional. The content-type header for the SAS. * * @type {string} - * @memberof IBlobSASSignatureValues + * @memberof BlobSASSignatureValues */ contentType?: string; } @@ -147,12 +147,12 @@ export interface IBlobSASSignatureValues { * this constructor. * * @export - * @param {IBlobSASSignatureValues} blobSASSignatureValues + * @param {BlobSASSignatureValues} blobSASSignatureValues * @param {SharedKeyCredential} sharedKeyCredential * @returns {SASQueryParameters} */ export function generateBlobSASQueryParameters( - blobSASSignatureValues: IBlobSASSignatureValues, + blobSASSignatureValues: BlobSASSignatureValues, sharedKeyCredential: SharedKeyCredential ): SASQueryParameters { if ( diff --git a/sdk/storage/storage-blob/src/BlockBlobClient.ts b/sdk/storage/storage-blob/src/BlockBlobClient.ts index 6460323e3978..6d44b106d09f 100644 --- a/sdk/storage/storage-blob/src/BlockBlobClient.ts +++ b/sdk/storage/storage-blob/src/BlockBlobClient.ts @@ -5,38 +5,38 @@ import { Aborter } from "./Aborter"; import { BlobClient } from "./BlobClient"; import { ContainerClient } from "./ContainerClient"; import { BlockBlob } from "./generated/lib/operations"; -import { IRange, rangeToString } from "./IRange"; -import { IBlobAccessConditions, IMetadata } from "./models"; +import { Range, rangeToString } from "./Range"; +import { BlobAccessConditions, Metadata } from "./models"; import { Pipeline } from "./Pipeline"; import { URLConstants } from "./utils/constants"; import { appendToURLPath, setURLParameter } from "./utils/utils.common"; -export interface IBlockBlobUploadOptions { - accessConditions?: IBlobAccessConditions; +export interface BlockBlobUploadOptions { + accessConditions?: BlobAccessConditions; blobHTTPHeaders?: Models.BlobHTTPHeaders; - metadata?: IMetadata; + metadata?: Metadata; progress?: (progress: TransferProgressEvent) => void; } -export interface IBlockBlobStageBlockOptions { +export interface BlockBlobStageBlockOptions { leaseAccessConditions?: Models.LeaseAccessConditions; progress?: (progress: TransferProgressEvent) => void; transactionalContentMD5?: Uint8Array; } -export interface IBlockBlobStageBlockFromURLOptions { - range?: IRange; +export interface BlockBlobStageBlockFromURLOptions { + range?: Range; leaseAccessConditions?: Models.LeaseAccessConditions; sourceContentMD5?: Uint8Array; } -export interface IBlockBlobCommitBlockListOptions { - accessConditions?: IBlobAccessConditions; +export interface BlockBlobCommitBlockListOptions { + accessConditions?: BlobAccessConditions; blobHTTPHeaders?: Models.BlobHTTPHeaders; - metadata?: IMetadata; + metadata?: Metadata; } -export interface IBlockBlobGetBlockListOptions { +export interface BlockBlobGetBlockListOptions { leaseAccessConditions?: Models.LeaseAccessConditions; } @@ -162,7 +162,7 @@ export class BlockBlobClient extends BlobClient { * which returns a new Readable stream whose offset is from data source beginning. * @param {number} contentLength Length of body in bytes. Use Buffer.byteLength() to calculate body length for a * string including non non-Base64/Hex-encoded characters. - * @param {IBlockBlobUploadOptions} [options] + * @param {BlockBlobUploadOptions} [options] * @returns {Promise} * @memberof BlockBlobClient */ @@ -170,7 +170,7 @@ export class BlockBlobClient extends BlobClient { aborter: Aborter, body: HttpRequestBody, contentLength: number, - options: IBlockBlobUploadOptions = {} + options: BlockBlobUploadOptions = {} ): Promise { options.accessConditions = options.accessConditions || {}; return this.blockBlobContext.upload(body, contentLength, { @@ -193,7 +193,7 @@ export class BlockBlobClient extends BlobClient { * @param {string} blockId A 64-byte value that is base64-encoded * @param {HttpRequestBody} body * @param {number} contentLength - * @param {IBlockBlobStageBlockOptions} [options] + * @param {BlockBlobStageBlockOptions} [options] * @returns {Promise} * @memberof BlockBlobClient */ @@ -202,7 +202,7 @@ export class BlockBlobClient extends BlobClient { blockId: string, body: HttpRequestBody, contentLength: number, - options: IBlockBlobStageBlockOptions = {} + options: BlockBlobStageBlockOptions = {} ): Promise { return this.blockBlobContext.stageBlock(blockId, contentLength, body, { abortSignal: aborter, @@ -232,7 +232,7 @@ export class BlockBlobClient extends BlobClient { * - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot= * @param {number} offset From which position of the blob to download, >= 0 * @param {number} [count] How much data to be downloaded, > 0. Will download to the end when undefined - * @param {IBlockBlobStageBlockFromURLOptions} [options={}] + * @param {BlockBlobStageBlockFromURLOptions} [options={}] * @returns {Promise} * @memberof BlockBlobClient */ @@ -242,7 +242,7 @@ export class BlockBlobClient extends BlobClient { sourceURL: string, offset: number, count?: number, - options: IBlockBlobStageBlockFromURLOptions = {} + options: BlockBlobStageBlockFromURLOptions = {} ): Promise { return this.blockBlobContext.stageBlockFromURL(blockId, 0, sourceURL, { abortSignal: aborter, @@ -263,14 +263,14 @@ export class BlockBlobClient extends BlobClient { * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(), * goto documents of Aborter for more examples about request cancellation * @param {string[]} blocks Array of 64-byte value that is base64-encoded - * @param {IBlockBlobCommitBlockListOptions} [options] + * @param {BlockBlobCommitBlockListOptions} [options] * @returns {Promise} * @memberof BlockBlobClient */ public async commitBlockList( aborter: Aborter, blocks: string[], - options: IBlockBlobCommitBlockListOptions = {} + options: BlockBlobCommitBlockListOptions = {} ): Promise { options.accessConditions = options.accessConditions || {}; return this.blockBlobContext.commitBlockList( @@ -293,14 +293,14 @@ export class BlockBlobClient extends BlobClient { * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(), * goto documents of Aborter for more examples about request cancellation * @param {Models.BlockListType} listType - * @param {IBlockBlobGetBlockListOptions} [options] + * @param {BlockBlobGetBlockListOptions} [options] * @returns {Promise} * @memberof BlockBlobClient */ public async getBlockList( aborter: Aborter, listType: Models.BlockListType, - options: IBlockBlobGetBlockListOptions = {} + options: BlockBlobGetBlockListOptions = {} ): Promise { const res = await this.blockBlobContext.getBlockList(listType, { abortSignal: aborter, diff --git a/sdk/storage/storage-blob/src/ContainerClient.ts b/sdk/storage/storage-blob/src/ContainerClient.ts index 2428e74d62e8..2c0975d7caca 100644 --- a/sdk/storage/storage-blob/src/ContainerClient.ts +++ b/sdk/storage/storage-blob/src/ContainerClient.ts @@ -2,35 +2,35 @@ import { HttpResponse } from "@azure/ms-rest-js"; import * as Models from "./generated/lib/models"; import { Aborter } from "./Aborter"; import { Container } from "./generated/lib/operations"; -import { IContainerAccessConditions, IMetadata } from "./models"; +import { ContainerAccessConditions, Metadata } from "./models"; import { Pipeline } from "./Pipeline"; import { ServiceClient } from "./ServiceClient"; import { StorageClient } from "./StorageClient"; import { ETagNone } from "./utils/constants"; import { appendToURLPath, truncatedISO8061Date } from "./utils/utils.common"; -export interface IContainerCreateOptions { - metadata?: IMetadata; +export interface ContainerCreateOptions { + metadata?: Metadata; access?: Models.PublicAccessType; } -export interface IContainerGetPropertiesOptions { +export interface ContainerGetPropertiesOptions { leaseAccessConditions?: Models.LeaseAccessConditions; } -export interface IContainerDeleteMethodOptions { - containerAccessConditions?: IContainerAccessConditions; +export interface ContainerDeleteMethodOptions { + containerAccessConditions?: ContainerAccessConditions; } -export interface IContainerSetMetadataOptions { - containerAccessConditions?: IContainerAccessConditions; +export interface ContainerSetMetadataOptions { + containerAccessConditions?: ContainerAccessConditions; } -export interface IContainerGetAccessPolicyOptions { +export interface ContainerGetAccessPolicyOptions { leaseAccessConditions?: Models.LeaseAccessConditions; } -export interface ISignedIdentifier { +export interface SignedIdentifier { /** * @member {string} id a unique id */ @@ -56,7 +56,7 @@ export interface ISignedIdentifier { } export declare type ContainerGetAccessPolicyResponse = { - signedIdentifiers: ISignedIdentifier[]; + signedIdentifiers: SignedIdentifier[]; } & Models.ContainerGetAccessPolicyHeaders & { /** * The underlying HTTP response. @@ -77,31 +77,31 @@ export declare type ContainerGetAccessPolicyResponse = { }; }; -export interface IContainerSetAccessPolicyOptions { - containerAccessConditions?: IContainerAccessConditions; +export interface ContainerSetAccessPolicyOptions { + containerAccessConditions?: ContainerAccessConditions; } -export interface IContainerAcquireLeaseOptions { +export interface ContainerAcquireLeaseOptions { modifiedAccessConditions?: Models.ModifiedAccessConditions; } -export interface IContainerReleaseLeaseOptions { +export interface ContainerReleaseLeaseOptions { modifiedAccessConditions?: Models.ModifiedAccessConditions; } -export interface IContainerRenewLeaseOptions { +export interface ContainerRenewLeaseOptions { modifiedAccessConditions?: Models.ModifiedAccessConditions; } -export interface IContainerBreakLeaseOptions { +export interface ContainerBreakLeaseOptions { modifiedAccessConditions?: Models.ModifiedAccessConditions; } -export interface IContainerChangeLeaseOptions { +export interface ContainerChangeLeaseOptions { modifiedAccessConditions?: Models.ModifiedAccessConditions; } -export interface IContainerListBlobsSegmentOptions { +export interface ContainerListBlobsSegmentOptions { /** * @member {string} [prefix] Filters the results to return only containers * whose name begins with the specified prefix. @@ -191,13 +191,13 @@ export class ContainerClient extends StorageClient { * * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(), * goto documents of Aborter for more examples about request cancellation - * @param {IContainerCreateOptions} [options] + * @param {ContainerCreateOptions} [options] * @returns {Promise} * @memberof ContainerClient */ public async create( aborter: Aborter, - options: IContainerCreateOptions = {} + options: ContainerCreateOptions = {} ): Promise { // Spread operator in destructuring assignments, // this will filter out unwanted properties from the response object into result object @@ -220,7 +220,7 @@ export class ContainerClient extends StorageClient { */ public async getProperties( aborter: Aborter, - options: IContainerGetPropertiesOptions = {} + options: ContainerGetPropertiesOptions = {} ): Promise { if (!options.leaseAccessConditions) { options.leaseAccessConditions = {}; @@ -245,7 +245,7 @@ export class ContainerClient extends StorageClient { */ public async delete( aborter: Aborter, - options: IContainerDeleteMethodOptions = {} + options: ContainerDeleteMethodOptions = {} ): Promise { if (!options.containerAccessConditions) { options.containerAccessConditions = {}; @@ -288,16 +288,16 @@ export class ContainerClient extends StorageClient { * * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(), * goto documents of Aborter for more examples about request cancellation - * @param {IMetadata} [metadata] Replace existing metadata with this value. + * @param {Metadata} [metadata] Replace existing metadata with this value. * If no value provided the existing metadata will be removed. - * @param {IContainerSetMetadataOptions} [options] + * @param {ContainerSetMetadataOptions} [options] * @returns {Promise} * @memberof ContainerClient */ public async setMetadata( aborter: Aborter, - metadata?: IMetadata, - options: IContainerSetMetadataOptions = {} + metadata?: Metadata, + options: ContainerSetMetadataOptions = {} ): Promise { if (!options.containerAccessConditions) { options.containerAccessConditions = {}; @@ -343,13 +343,13 @@ export class ContainerClient extends StorageClient { * * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(), * goto documents of Aborter for more examples about request cancellation - * @param {IContainerGetAccessPolicyOptions} [options] + * @param {ContainerGetAccessPolicyOptions} [options] * @returns {Promise} * @memberof ContainerClient */ public async getAccessPolicy( aborter: Aborter, - options: IContainerGetAccessPolicyOptions = {} + options: ContainerGetAccessPolicyOptions = {} ): Promise { if (!options.leaseAccessConditions) { options.leaseAccessConditions = {}; @@ -398,16 +398,16 @@ export class ContainerClient extends StorageClient { * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(), * goto documents of Aborter for more examples about request cancellation * @param {PublicAccessType} [access] - * @param {ISignedIdentifier[]} [containerAcl] - * @param {IContainerSetAccessPolicyOptions} [options] + * @param {SignedIdentifier[]} [containerAcl] + * @param {ContainerSetAccessPolicyOptions} [options] * @returns {Promise} * @memberof ContainerClient */ public async setAccessPolicy( aborter: Aborter, access?: Models.PublicAccessType, - containerAcl?: ISignedIdentifier[], - options: IContainerSetAccessPolicyOptions = {} + containerAcl?: SignedIdentifier[], + options: ContainerSetAccessPolicyOptions = {} ): Promise { options.containerAccessConditions = options.containerAccessConditions || {}; const acl: Models.SignedIdentifier[] = []; @@ -440,7 +440,7 @@ export class ContainerClient extends StorageClient { * goto documents of Aborter for more examples about request cancellation * @param {string} proposedLeaseId Can be specified in any valid GUID string format * @param {number} duration Must be between 15 to 60 seconds, or infinite (-1) - * @param {IContainerAcquireLeaseOptions} [options] + * @param {ContainerAcquireLeaseOptions} [options] * @returns {Promise} * @memberof ContainerClient */ @@ -448,7 +448,7 @@ export class ContainerClient extends StorageClient { aborter: Aborter, proposedLeaseId: string, duration: number, - options: IContainerAcquireLeaseOptions = {} + options: ContainerAcquireLeaseOptions = {} ): Promise { return this.containerContext.acquireLease({ abortSignal: aborter, @@ -466,14 +466,14 @@ export class ContainerClient extends StorageClient { * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(), * goto documents of Aborter for more examples about request cancellation * @param {string} leaseId - * @param {IContainerReleaseLeaseOptions} [options] + * @param {ContainerReleaseLeaseOptions} [options] * @returns {Promise} * @memberof ContainerClient */ public async releaseLease( aborter: Aborter, leaseId: string, - options: IContainerReleaseLeaseOptions = {} + options: ContainerReleaseLeaseOptions = {} ): Promise { return this.containerContext.releaseLease(leaseId, { abortSignal: aborter, @@ -488,14 +488,14 @@ export class ContainerClient extends StorageClient { * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(), * goto documents of Aborter for more examples about request cancellation * @param {string} leaseId - * @param {IContainerRenewLeaseOptions} [options] + * @param {ContainerRenewLeaseOptions} [options] * @returns {Promise} * @memberof ContainerClient */ public async renewLease( aborter: Aborter, leaseId: string, - options: IContainerRenewLeaseOptions = {} + options: ContainerRenewLeaseOptions = {} ): Promise { return this.containerContext.renewLease(leaseId, { abortSignal: aborter, @@ -511,14 +511,14 @@ export class ContainerClient extends StorageClient { * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(), * goto documents of Aborter for more examples about request cancellation * @param {number} period break period - * @param {IContainerBreakLeaseOptions} [options] + * @param {ContainerBreakLeaseOptions} [options] * @returns {Promise} * @memberof ContainerClient */ public async breakLease( aborter: Aborter, period: number, - options: IContainerBreakLeaseOptions = {} + options: ContainerBreakLeaseOptions = {} ): Promise { return this.containerContext.breakLease({ abortSignal: aborter, @@ -535,7 +535,7 @@ export class ContainerClient extends StorageClient { * goto documents of Aborter for more examples about request cancellation * @param {string} leaseId * @param {string} proposedLeaseId - * @param {IContainerChangeLeaseOptions} [options] + * @param {ContainerChangeLeaseOptions} [options] * @returns {Promise} * @memberof ContainerClient */ @@ -543,7 +543,7 @@ export class ContainerClient extends StorageClient { aborter: Aborter, leaseId: string, proposedLeaseId: string, - options: IContainerChangeLeaseOptions = {} + options: ContainerChangeLeaseOptions = {} ): Promise { return this.containerContext.changeLease(leaseId, proposedLeaseId, { abortSignal: aborter, @@ -561,14 +561,14 @@ export class ContainerClient extends StorageClient { * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(), * goto documents of Aborter for more examples about request cancellation * @param {string} [marker] - * @param {IContainerListBlobsSegmentOptions} [options] + * @param {ContainerListBlobsSegmentOptions} [options] * @returns {Promise} * @memberof ContainerClient */ public async listBlobFlatSegment( aborter: Aborter, marker?: string, - options: IContainerListBlobsSegmentOptions = {} + options: ContainerListBlobsSegmentOptions = {} ): Promise { return this.containerContext.listBlobFlatSegment({ abortSignal: aborter, @@ -587,7 +587,7 @@ export class ContainerClient extends StorageClient { * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(), * goto documents of Aborter for more examples about request cancellation * @param {string} delimiter - * @param {IContainerListBlobsSegmentOptions} [options] + * @param {ContainerListBlobsSegmentOptions} [options] * @returns {Promise} * @memberof ContainerClient */ @@ -595,7 +595,7 @@ export class ContainerClient extends StorageClient { aborter: Aborter, delimiter: string, marker?: string, - options: IContainerListBlobsSegmentOptions = {} + options: ContainerListBlobsSegmentOptions = {} ): Promise { return this.containerContext.listBlobHierarchySegment(delimiter, { abortSignal: aborter, diff --git a/sdk/storage/storage-blob/src/ContainerSASPermissions.ts b/sdk/storage/storage-blob/src/ContainerSASPermissions.ts index 7c80f3ad8f0c..6ee54eaa20d8 100644 --- a/sdk/storage/storage-blob/src/ContainerSASPermissions.ts +++ b/sdk/storage/storage-blob/src/ContainerSASPermissions.ts @@ -2,7 +2,7 @@ * This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a container. * Setting a value to true means that any SAS which uses these permissions will grant permissions for that operation. * Once all the values are set, this should be serialized with toString and set as the permissions field on a - * {@link IBlobSASSignatureValues} object. It is possible to construct the permissions string without this class, but + * {@link BlobSASSignatureValues} object. It is possible to construct the permissions string without this class, but * the order of the permissions is particular and this class guarantees correctness. * * @export diff --git a/sdk/storage/storage-blob/src/IIPRange.ts b/sdk/storage/storage-blob/src/IPRange.ts similarity index 81% rename from sdk/storage/storage-blob/src/IIPRange.ts rename to sdk/storage/storage-blob/src/IPRange.ts index aa15037871e6..0386f2db7bd8 100644 --- a/sdk/storage/storage-blob/src/IIPRange.ts +++ b/sdk/storage/storage-blob/src/IPRange.ts @@ -2,9 +2,9 @@ * Allowed IP range for a SAS. * * @export - * @interface IIPRange + * @interface IPRange */ -export interface IIPRange { +export interface IPRange { /** * Starting IP address in the IP range. * If end IP doesn't provide, start IP will the only IP allowed. @@ -29,9 +29,9 @@ export interface IIPRange { * "8.8.8.8" or "1.1.1.1-255.255.255.255" * * @export - * @param {IIPRange} ipRange + * @param {IPRange} ipRange * @returns {string} */ -export function ipRangeToString(ipRange: IIPRange): string { +export function ipRangeToString(ipRange: IPRange): string { return ipRange.end ? `${ipRange.start}-${ipRange.end}` : ipRange.start; } diff --git a/sdk/storage/storage-blob/src/LoggingPolicyFactory.ts b/sdk/storage/storage-blob/src/LoggingPolicyFactory.ts index d6f1057480b4..60862297ad05 100644 --- a/sdk/storage/storage-blob/src/LoggingPolicyFactory.ts +++ b/sdk/storage/storage-blob/src/LoggingPolicyFactory.ts @@ -6,14 +6,14 @@ import { LoggingPolicy } from "./policies/LoggingPolicy"; * RequestLogOptions configures the retry policy's behavior. * * @export - * @interface IRequestLogOptions + * @interface RequestLogOptions */ -export interface IRequestLogOptions { +export interface RequestLogOptions { /** * LogWarningIfTryOverThreshold logs a warning if a tried operation takes longer than the specified * duration in ms. Default is 3000ms. * @type {number} - * @memberof IRequestLogOptions + * @memberof RequestLogOptions */ logWarningIfTryOverThreshold: number; } @@ -26,9 +26,9 @@ export interface IRequestLogOptions { * @implements {RequestPolicyFactory} */ export class LoggingPolicyFactory implements RequestPolicyFactory { - private readonly loggingOptions?: IRequestLogOptions; + private readonly loggingOptions?: RequestLogOptions; - constructor(loggingOptions?: IRequestLogOptions) { + constructor(loggingOptions?: RequestLogOptions) { this.loggingOptions = loggingOptions; } diff --git a/sdk/storage/storage-blob/src/PageBlobClient.ts b/sdk/storage/storage-blob/src/PageBlobClient.ts index 9e2a49d2d67f..78837b9c99ec 100644 --- a/sdk/storage/storage-blob/src/PageBlobClient.ts +++ b/sdk/storage/storage-blob/src/PageBlobClient.ts @@ -5,47 +5,47 @@ import { Aborter } from "./Aborter"; import { BlobClient } from "./BlobClient"; import { ContainerClient } from "./ContainerClient"; import { PageBlob } from "./generated/lib/operations"; -import { rangeToString } from "./IRange"; -import { IBlobAccessConditions, IMetadata, IPageBlobAccessConditions } from "./models"; +import { rangeToString } from "./Range"; +import { BlobAccessConditions, Metadata, PageBlobAccessConditions } from "./models"; import { Pipeline } from "./Pipeline"; import { URLConstants } from "./utils/constants"; import { appendToURLPath, setURLParameter } from "./utils/utils.common"; -export interface IPageBlobCreateOptions { - accessConditions?: IBlobAccessConditions; +export interface PageBlobCreateOptions { + accessConditions?: BlobAccessConditions; blobSequenceNumber?: number; blobHTTPHeaders?: Models.BlobHTTPHeaders; - metadata?: IMetadata; + metadata?: Metadata; } -export interface IPageBlobUploadPagesOptions { - accessConditions?: IPageBlobAccessConditions; +export interface PageBlobUploadPagesOptions { + accessConditions?: PageBlobAccessConditions; progress?: (progress: TransferProgressEvent) => void; transactionalContentMD5?: Uint8Array; } -export interface IPageBlobClearPagesOptions { - accessConditions?: IPageBlobAccessConditions; +export interface PageBlobClearPagesOptions { + accessConditions?: PageBlobAccessConditions; } -export interface IPageBlobGetPageRangesOptions { - accessConditions?: IBlobAccessConditions; +export interface PageBlobGetPageRangesOptions { + accessConditions?: BlobAccessConditions; } -export interface IPageBlobGetPageRangesDiffOptions { - accessConditions?: IBlobAccessConditions; +export interface PageBlobGetPageRangesDiffOptions { + accessConditions?: BlobAccessConditions; range?: string; } -export interface IPageBlobResizeOptions { - accessConditions?: IBlobAccessConditions; +export interface PageBlobResizeOptions { + accessConditions?: BlobAccessConditions; } -export interface IPageBlobUpdateSequenceNumberOptions { - accessConditions?: IBlobAccessConditions; +export interface PageBlobUpdateSequenceNumberOptions { + accessConditions?: BlobAccessConditions; } -export interface IPageBlobStartCopyIncrementalOptions { +export interface PageBlobStartCopyIncrementalOptions { modifiedAccessConditions?: Models.ModifiedAccessConditions; } @@ -160,14 +160,14 @@ export class PageBlobClient extends BlobClient { * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(), * goto documents of Aborter for more examples about request cancellation * @param {number} size - * @param {IPageBlobCreateOptions} [options] + * @param {PageBlobCreateOptions} [options] * @returns {Promise} * @memberof PageBlobClient */ public async create( aborter: Aborter, size: number, - options: IPageBlobCreateOptions = {} + options: PageBlobCreateOptions = {} ): Promise { options.accessConditions = options.accessConditions || {}; return this.pageBlobContext.create(0, size, { @@ -189,7 +189,7 @@ export class PageBlobClient extends BlobClient { * @param {HttpRequestBody} body * @param {number} offset Offset of destination page blob * @param {number} count Content length of body, also how many bytes to be uploaded - * @param {IPageBlobUploadPagesOptions} [options] + * @param {PageBlobUploadPagesOptions} [options] * @returns {Promise} * @memberof PageBlobClient */ @@ -198,7 +198,7 @@ export class PageBlobClient extends BlobClient { body: HttpRequestBody, offset: number, count: number, - options: IPageBlobUploadPagesOptions = {} + options: PageBlobUploadPagesOptions = {} ): Promise { options.accessConditions = options.accessConditions || {}; return this.pageBlobContext.uploadPages(body, count, { @@ -220,7 +220,7 @@ export class PageBlobClient extends BlobClient { * goto documents of Aborter for more examples about request cancellation * @param {number} offset * @param {number} count - * @param {IPageBlobClearPagesOptions} [options] + * @param {PageBlobClearPagesOptions} [options] * @returns {Promise} * @memberof PageBlobClient */ @@ -228,7 +228,7 @@ export class PageBlobClient extends BlobClient { aborter: Aborter, offset: number, count: number, - options: IPageBlobClearPagesOptions = {} + options: PageBlobClearPagesOptions = {} ): Promise { options.accessConditions = options.accessConditions || {}; return this.pageBlobContext.clearPages(0, { @@ -248,7 +248,7 @@ export class PageBlobClient extends BlobClient { * goto documents of Aborter for more examples about request cancellation * @param {number} offset * @param {number} count - * @param {IPageBlobGetPageRangesOptions} [options] + * @param {PageBlobGetPageRangesOptions} [options] * @returns {Promise} * @memberof PageBlobClient */ @@ -256,7 +256,7 @@ export class PageBlobClient extends BlobClient { aborter: Aborter, offset: number, count: number, - options: IPageBlobGetPageRangesOptions = {} + options: PageBlobGetPageRangesOptions = {} ): Promise { options.accessConditions = options.accessConditions || {}; return this.pageBlobContext.getPageRanges({ @@ -276,7 +276,7 @@ export class PageBlobClient extends BlobClient { * @param {number} offset * @param {number} count * @param {string} prevSnapshot - * @param {IPageBlobGetPageRangesDiffOptions} [options] + * @param {PageBlobGetPageRangesDiffOptions} [options] * @returns {Promise} * @memberof PageBlobClient */ @@ -285,7 +285,7 @@ export class PageBlobClient extends BlobClient { offset: number, count: number, prevSnapshot: string, - options: IPageBlobGetPageRangesDiffOptions = {} + options: PageBlobGetPageRangesDiffOptions = {} ): Promise { options.accessConditions = options.accessConditions || {}; return this.pageBlobContext.getPageRangesDiff({ @@ -304,14 +304,14 @@ export class PageBlobClient extends BlobClient { * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(), * goto documents of Aborter for more examples about request cancellation * @param {number} size - * @param {IPageBlobResizeOptions} [options] + * @param {PageBlobResizeOptions} [options] * @returns {Promise} * @memberof PageBlobClient */ public async resize( aborter: Aborter, size: number, - options: IPageBlobResizeOptions = {} + options: PageBlobResizeOptions = {} ): Promise { options.accessConditions = options.accessConditions || {}; return this.pageBlobContext.resize(size, { @@ -329,7 +329,7 @@ export class PageBlobClient extends BlobClient { * goto documents of Aborter for more examples about request cancellation * @param {Models.SequenceNumberActionType} sequenceNumberAction * @param {number} [sequenceNumber] Required if sequenceNumberAction is max or update - * @param {IPageBlobUpdateSequenceNumberOptions} [options] + * @param {PageBlobUpdateSequenceNumberOptions} [options] * @returns {Promise} * @memberof PageBlobClient */ @@ -337,7 +337,7 @@ export class PageBlobClient extends BlobClient { aborter: Aborter, sequenceNumberAction: Models.SequenceNumberActionType, sequenceNumber?: number, - options: IPageBlobUpdateSequenceNumberOptions = {} + options: PageBlobUpdateSequenceNumberOptions = {} ): Promise { options.accessConditions = options.accessConditions || {}; return this.pageBlobContext.updateSequenceNumber(sequenceNumberAction, { @@ -360,14 +360,14 @@ export class PageBlobClient extends BlobClient { * goto documents of Aborter for more examples about request cancellation * @param {string} copySource Specifies the name of the source page blob snapshot. For example, * https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot= - * @param {IPageBlobStartCopyIncrementalOptions} [options] + * @param {PageBlobStartCopyIncrementalOptions} [options] * @returns {Promise} * @memberof PageBlobClient */ public async startCopyIncremental( aborter: Aborter, copySource: string, - options: IPageBlobStartCopyIncrementalOptions = {} + options: PageBlobStartCopyIncrementalOptions = {} ): Promise { return this.pageBlobContext.copyIncremental(copySource, { abortSignal: aborter, diff --git a/sdk/storage/storage-blob/src/Pipeline.ts b/sdk/storage/storage-blob/src/Pipeline.ts index 3e6f2e560472..05d1b925b11e 100644 --- a/sdk/storage/storage-blob/src/Pipeline.ts +++ b/sdk/storage/storage-blob/src/Pipeline.ts @@ -33,9 +33,9 @@ export { * Option interface for Pipeline constructor. * * @export - * @interface IPipelineOptions + * @interface PipelineOptions */ -export interface IPipelineOptions { +export interface PipelineOptions { logger?: IHttpPipelineLogger; HTTPClient?: IHttpClient; } @@ -52,16 +52,16 @@ export interface IPipelineOptions { */ export class Pipeline { public readonly factories: RequestPolicyFactory[]; - public readonly options: IPipelineOptions; + public readonly options: PipelineOptions; /** * Creates an instance of Pipeline. Customize HTTPClient by implementing IHttpClient interface. * * @param {RequestPolicyFactory[]} factories - * @param {IPipelineOptions} [options={}] + * @param {PipelineOptions} [options={}] * @memberof Pipeline */ - constructor(factories: RequestPolicyFactory[], options: IPipelineOptions = {}) { + constructor(factories: RequestPolicyFactory[], options: PipelineOptions = {}) { this.factories = factories; this.options = options; } diff --git a/sdk/storage/storage-blob/src/IRange.ts b/sdk/storage/storage-blob/src/Range.ts similarity index 70% rename from sdk/storage/storage-blob/src/IRange.ts rename to sdk/storage/storage-blob/src/Range.ts index 1615bbf57910..170382512263 100644 --- a/sdk/storage/storage-blob/src/IRange.ts +++ b/sdk/storage/storage-blob/src/Range.ts @@ -4,14 +4,14 @@ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-blob-service-operations * * @export - * @interface IRange + * @interface Range */ -export interface IRange { +export interface Range { /** * StartByte, larger than or equal 0. * * @type {string} - * @memberof IRange + * @memberof Range */ offset: number; /** @@ -19,7 +19,7 @@ export interface IRange { * If not provided, will return bytes from offset to the end. * * @type {string} - * @memberof IRange + * @memberof Range */ count?: number; } @@ -30,16 +30,16 @@ export interface IRange { * "bytes=255-" or "bytes=0-511" * * @export - * @param {IRange} iRange + * @param {Range} iRange * @returns {string} */ -export function rangeToString(iRange: IRange): string { +export function rangeToString(iRange: Range): string { if (iRange.offset < 0) { - throw new RangeError(`IRange.offset cannot be smaller than 0.`); + throw new RangeError(`Range.offset cannot be smaller than 0.`); } if (iRange.count && iRange.count <= 0) { throw new RangeError( - `IRange.count must be larger than 0. Leave it undefined if you want a range from offset to the end.` + `Range.count must be larger than 0. Leave it undefined if you want a range from offset to the end.` ); } return iRange.count diff --git a/sdk/storage/storage-blob/src/RetryPolicyFactory.ts b/sdk/storage/storage-blob/src/RetryPolicyFactory.ts index 1918e1cdf405..4a296ebed62a 100644 --- a/sdk/storage/storage-blob/src/RetryPolicyFactory.ts +++ b/sdk/storage/storage-blob/src/RetryPolicyFactory.ts @@ -6,9 +6,9 @@ import { RetryPolicy, RetryPolicyType } from "./policies/RetryPolicy"; * Retry options interface. * * @export - * @interface IRetryOptions + * @interface RetryOptions */ -export interface IRetryOptions { +export interface RetryOptions { /** * Optional. RetryPolicyType, default is exponential retry policy. * @@ -23,7 +23,7 @@ export interface IRetryOptions { * A value smaller than 1 means default retry number of attempts. * * @type {number} - * @memberof IRetryOptions + * @memberof RetryOptions */ readonly maxTries?: number; @@ -35,7 +35,7 @@ export interface IRetryOptions { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-blob-service-operations * * @type {number} - * @memberof IRetryOptions + * @memberof RetryOptions */ readonly tryTimeoutInMs?: number; @@ -45,7 +45,7 @@ export interface IRetryOptions { * maxRetryDelayInMs. If you specify 0, then you must also specify 0 for maxRetryDelayInMs. * * @type {number} - * @memberof IRetryOptions + * @memberof RetryOptions */ readonly retryDelayInMs?: number; @@ -54,7 +54,7 @@ export interface IRetryOptions { * If you specify 0, then you must also specify 0 for retryDelayInMs. * * @type {number} - * @memberof IRetryOptions + * @memberof RetryOptions */ readonly maxRetryDelayInMs?: number; @@ -67,7 +67,7 @@ export interface IRetryOptions { * {@link https://docs.microsoft.com/en-us/azure/storage/common/storage-designing-ha-apps-with-ragrs} * * @type {string} - * @memberof IRetryOptions + * @memberof RetryOptions */ readonly secondaryHost?: string; } @@ -80,14 +80,14 @@ export interface IRetryOptions { * @implements {RequestPolicyFactory} */ export class RetryPolicyFactory implements RequestPolicyFactory { - private retryOptions?: IRetryOptions; + private retryOptions?: RetryOptions; /** * Creates an instance of RetryPolicyFactory. - * @param {IRetryOptions} [retryOptions] + * @param {RetryOptions} [retryOptions] * @memberof RetryPolicyFactory */ - constructor(retryOptions?: IRetryOptions) { + constructor(retryOptions?: RetryOptions) { this.retryOptions = retryOptions; } diff --git a/sdk/storage/storage-blob/src/SASQueryParameters.ts b/sdk/storage/storage-blob/src/SASQueryParameters.ts index 5b73e1db9131..f97161e986db 100644 --- a/sdk/storage/storage-blob/src/SASQueryParameters.ts +++ b/sdk/storage/storage-blob/src/SASQueryParameters.ts @@ -1,4 +1,4 @@ -import { IIPRange, ipRangeToString } from "./IIPRange"; +import { IPRange, ipRangeToString } from "./IPRange"; import { truncatedISO8061Date } from "./utils/utils.common"; /** @@ -21,7 +21,7 @@ export enum SASProtocol { /** * Represents the components that make up an Azure Storage SAS' query parameters. This type is not constructed directly - * by the user; it is only generated by the {@link IAccountSASSignatureValues} and {@link IBlobSASSignatureValues} + * by the user; it is only generated by the {@link AccountSASSignatureValues} and {@link BlobSASSignatureValues} * types. Once generated, it can be encoded into a {@code String} and appended to a URL directly (though caution should * be taken here in case there are existing query parameters, which might affect the appropriate means of appending * these query parameters). @@ -93,7 +93,7 @@ export class SASQueryParameters { public readonly resourceTypes?: string; /** - * Optional. The signed identifier (only for {@link IBlobSASSignatureValues}). + * Optional. The signed identifier (only for {@link BlobSASSignatureValues}). * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy * @@ -103,7 +103,7 @@ export class SASQueryParameters { public readonly identifier?: string; /** - * Optional. The storage container or blob (only for {@link IBlobSASSignatureValues}). + * Optional. The storage container or blob (only for {@link BlobSASSignatureValues}). * * @type {string} * @memberof SASQueryParameters @@ -162,19 +162,19 @@ export class SASQueryParameters { * Inner value of getter ipRange. * * @private - * @type {IIPRange} + * @type {IPRange} * @memberof SASQueryParameters */ - private readonly ipRangeInner?: IIPRange; + private readonly ipRangeInner?: IPRange; /** * Optional. IP range allowed for this SAS. * * @readonly - * @type {(IIPRange | undefined)} + * @type {(IPRange | undefined)} * @memberof SASQueryParameters */ - public get ipRange(): IIPRange | undefined { + public get ipRange(): IPRange | undefined { if (this.ipRangeInner) { return { end: this.ipRangeInner.end, @@ -195,7 +195,7 @@ export class SASQueryParameters { * @param {SASProtocol} [protocol] Representing the allowed HTTP protocol(s) * @param {Date} [startTime] Representing the start time for this SAS token * @param {Date} [expiryTime] Representing the expiry time for this SAS token - * @param {IIPRange} [ipRange] Representing the range of valid IP addresses for this SAS token + * @param {IPRange} [ipRange] Representing the range of valid IP addresses for this SAS token * @param {string} [identifier] Representing the signed identifier (only for Service SAS) * @param {string} [resource] Representing the storage container or blob (only for Service SAS) * @param {string} [cacheControl] Representing the cache-control header (only for Blob/File Service SAS) @@ -214,7 +214,7 @@ export class SASQueryParameters { protocol?: SASProtocol, startTime?: Date, expiryTime?: Date, - ipRange?: IIPRange, + ipRange?: IPRange, identifier?: string, resource?: string, cacheControl?: string, diff --git a/sdk/storage/storage-blob/src/ServiceClient.ts b/sdk/storage/storage-blob/src/ServiceClient.ts index 206af50b5515..e4e7fdbe4745 100644 --- a/sdk/storage/storage-blob/src/ServiceClient.ts +++ b/sdk/storage/storage-blob/src/ServiceClient.ts @@ -5,7 +5,7 @@ import { Service } from "./generated/lib/operations"; import { Pipeline } from "./Pipeline"; import { StorageClient } from "./StorageClient"; -export interface IServiceListContainersSegmentOptions { +export interface ServiceListContainersSegmentOptions { /** * @member {string} [prefix] Filters the results to return only containers * whose name begins with the specified prefix. @@ -158,14 +158,14 @@ export class ServiceClient extends StorageClient { * with the current page. The NextMarker value can be used as the value for * the marker parameter in a subsequent call to request the next page of list * items. The marker value is opaque to the client. - * @param {IServiceListContainersSegmentOptions} [options] + * @param {ServiceListContainersSegmentOptions} [options] * @returns {Promise} * @memberof ServiceClient */ public async listContainersSegment( aborter: Aborter, marker?: string, - options: IServiceListContainersSegmentOptions = {} + options: ServiceListContainersSegmentOptions = {} ): Promise { return this.serviceContext.listContainersSegment({ abortSignal: aborter, diff --git a/sdk/storage/storage-blob/src/StorageClient.ts b/sdk/storage/storage-blob/src/StorageClient.ts index 7ae054ae2f39..4cc0b36b307b 100644 --- a/sdk/storage/storage-blob/src/StorageClient.ts +++ b/sdk/storage/storage-blob/src/StorageClient.ts @@ -5,8 +5,8 @@ import { Credential } from "./credentials/Credential"; import { StorageClientContext } from "./generated/lib/storageClientContext"; import { LoggingPolicyFactory } from "./LoggingPolicyFactory"; import { IHttpClient, IHttpPipelineLogger, Pipeline } from "./Pipeline"; -import { IRetryOptions, RetryPolicyFactory } from "./RetryPolicyFactory"; -import { ITelemetryOptions, TelemetryPolicyFactory } from "./TelemetryPolicyFactory"; +import { RetryOptions, RetryPolicyFactory } from "./RetryPolicyFactory"; +import { TelemetryOptions, TelemetryPolicyFactory } from "./TelemetryPolicyFactory"; import { UniqueRequestIDPolicyFactory } from "./UniqueRequestIDPolicyFactory"; import { escapeURLPath } from "./utils/utils.common"; @@ -16,17 +16,17 @@ export { deserializationPolicy }; * Option interface for Pipeline.newPipeline method. * * @export - * @interface INewPipelineOptions + * @interface NewPipelineOptions */ -export interface INewPipelineOptions { +export interface NewPipelineOptions { /** * Telemetry configures the built-in telemetry policy behavior. * - * @type {ITelemetryOptions} - * @memberof INewPipelineOptions + * @type {TelemetryOptions} + * @memberof NewPipelineOptions */ - telemetry?: ITelemetryOptions; - retryOptions?: IRetryOptions; + telemetry?: TelemetryOptions; + retryOptions?: RetryOptions; logger?: IHttpPipelineLogger; httpClient?: IHttpClient; @@ -44,13 +44,13 @@ export abstract class StorageClient { * * @static * @param {Credential} credential Such as AnonymousCredential, SharedKeyCredential or TokenCredential. - * @param {INewPipelineOptions} [pipelineOptions] Optional. Options. + * @param {NewPipelineOptions} [pipelineOptions] Optional. Options. * @returns {Pipeline} A new Pipeline object. * @memberof Pipeline */ public static newPipeline( credential: Credential, - pipelineOptions: INewPipelineOptions = {} + pipelineOptions: NewPipelineOptions = {} ): Pipeline { // Order is important. Closer to the API at the top & closer to the network at the bottom. // The credential's policy factory must appear close to the wire so it can sign any diff --git a/sdk/storage/storage-blob/src/TelemetryPolicyFactory.ts b/sdk/storage/storage-blob/src/TelemetryPolicyFactory.ts index a75dad719028..28acfba15f2b 100644 --- a/sdk/storage/storage-blob/src/TelemetryPolicyFactory.ts +++ b/sdk/storage/storage-blob/src/TelemetryPolicyFactory.ts @@ -13,9 +13,9 @@ import { SDK_VERSION } from "./utils/constants"; * Interface of TelemetryPolicy options. * * @export - * @interface ITelemetryOptions + * @interface TelemetryOptions */ -export interface ITelemetryOptions { +export interface TelemetryOptions { value: string; } @@ -31,10 +31,10 @@ export class TelemetryPolicyFactory implements RequestPolicyFactory { /** * Creates an instance of TelemetryPolicyFactory. - * @param {ITelemetryOptions} [telemetry] + * @param {TelemetryOptions} [telemetry] * @memberof TelemetryPolicyFactory */ - constructor(telemetry?: ITelemetryOptions) { + constructor(telemetry?: TelemetryOptions) { const userAgentInfo: string[] = []; if (isNode) { diff --git a/sdk/storage/storage-blob/src/highlevel.browser.ts b/sdk/storage/storage-blob/src/highlevel.browser.ts index 4995f3a806cc..b56ca80c1605 100644 --- a/sdk/storage/storage-blob/src/highlevel.browser.ts +++ b/sdk/storage/storage-blob/src/highlevel.browser.ts @@ -2,7 +2,7 @@ import { generateUuid } from "@azure/ms-rest-js"; import { Aborter } from "./Aborter"; import { BlockBlobClient } from "./BlockBlobClient"; -import { BlobUploadCommonResponse, IUploadToBlockBlobOptions } from "./highlevel.common"; +import { BlobUploadCommonResponse, UploadToBlockBlobOptions } from "./highlevel.common"; import { Batch } from "./utils/Batch"; import { BLOCK_BLOB_MAX_BLOCKS, @@ -26,14 +26,14 @@ import { generateBlockID } from "./utils/utils.common"; * goto documents of Aborter for more examples about request cancellation * @param {Blob | ArrayBuffer | ArrayBufferView} browserData Blob, File, ArrayBuffer or ArrayBufferView * @param {BlockBlobClient} blockBlobClient - * @param {IUploadToBlockBlobOptions} [options] + * @param {UploadToBlockBlobOptions} [options] * @returns {Promise} */ export async function uploadBrowserDataToBlockBlob( aborter: Aborter, browserData: Blob | ArrayBuffer | ArrayBufferView, blockBlobClient: BlockBlobClient, - options?: IUploadToBlockBlobOptions + options?: UploadToBlockBlobOptions ): Promise { const browserBlob = new Blob([browserData]); return UploadSeekableBlobToBlockBlob( @@ -62,7 +62,7 @@ export async function uploadBrowserDataToBlockBlob( * @param {(offset: number, size: number) => Blob} blobFactory * @param {number} size * @param {BlockBlobClient} blockBlobClient - * @param {IUploadToBlockBlobOptions} [options] + * @param {UploadToBlockBlobOptions} [options] * @returns {Promise} */ async function UploadSeekableBlobToBlockBlob( @@ -70,7 +70,7 @@ async function UploadSeekableBlobToBlockBlob( blobFactory: (offset: number, size: number) => Blob, size: number, blockBlobClient: BlockBlobClient, - options: IUploadToBlockBlobOptions = {} + options: UploadToBlockBlobOptions = {} ): Promise { if (!options.blockSize) { options.blockSize = 0; diff --git a/sdk/storage/storage-blob/src/highlevel.common.ts b/sdk/storage/storage-blob/src/highlevel.common.ts index 19391e146b0b..274b7f7c2799 100644 --- a/sdk/storage/storage-blob/src/highlevel.common.ts +++ b/sdk/storage/storage-blob/src/highlevel.common.ts @@ -1,20 +1,20 @@ import { HttpResponse, TransferProgressEvent } from "@azure/ms-rest-js"; import * as Models from "./generated/lib/models"; -import { IBlobAccessConditions } from "./models"; +import { BlobAccessConditions } from "./models"; /** * Option interface for uploadFileToBlockBlob and uploadSeekableStreamToBlockBlob. * * @export - * @interface IUploadToBlockBlobOptions + * @interface UploadToBlockBlobOptions */ -export interface IUploadToBlockBlobOptions { +export interface UploadToBlockBlobOptions { /** * Destination block blob size in bytes. * * @type {number} - * @memberof IUploadToBlockBlobOptions + * @memberof UploadToBlockBlobOptions */ blockSize?: number; @@ -25,14 +25,14 @@ export interface IUploadToBlockBlobOptions { * You can customize a value less equal than the default value. * * @type {number} - * @memberof IUploadToBlockBlobOptions + * @memberof UploadToBlockBlobOptions */ maxSingleShotSize?: number; /** * Progress updater. * - * @memberof IUploadToBlockBlobOptions + * @memberof UploadToBlockBlobOptions */ progress?: (progress: TransferProgressEvent) => void; @@ -40,7 +40,7 @@ export interface IUploadToBlockBlobOptions { * Blob HTTP Headers. * * @type {IBlobHTTPHeaders} - * @memberof IUploadToBlockBlobOptions + * @memberof UploadToBlockBlobOptions */ blobHTTPHeaders?: Models.BlobHTTPHeaders; @@ -48,23 +48,23 @@ export interface IUploadToBlockBlobOptions { * Metadata of block blob. * * @type {{ [propertyName: string]: string }} - * @memberof IUploadToBlockBlobOptions + * @memberof UploadToBlockBlobOptions */ metadata?: { [propertyName: string]: string }; /** * Access conditions headers. * - * @type {IBlobAccessConditions} - * @memberof IUploadToBlockBlobOptions + * @type {BlobAccessConditions} + * @memberof UploadToBlockBlobOptions */ - blobAccessConditions?: IBlobAccessConditions; + blobAccessConditions?: BlobAccessConditions; /** * Concurrency of parallel uploading. Must be >= 0. * * @type {number} - * @memberof IUploadToBlockBlobOptions + * @memberof UploadToBlockBlobOptions */ parallelism?: number; } @@ -88,16 +88,16 @@ export type BlobUploadCommonResponse = Models.BlockBlobUploadHeaders & { * Option interface for DownloadBlockBlobToBuffer. * * @export - * @interface IDownloadFromBlobOptions + * @interface DownloadFromBlobOptions */ -export interface IDownloadFromBlobOptions { +export interface DownloadFromBlobOptions { /** * blockSize is the data every request trying to download. * Must be >= 0, if set to 0 or undefined, blockSize will automatically calculated according * to the blob size. * * @type {number} - * @memberof IDownloadFromBlobOptions + * @memberof DownloadFromBlobOptions */ blockSize?: number; @@ -115,30 +115,30 @@ export interface IDownloadFromBlobOptions { * Default value is 5, please set a larger value when in poor network. * * @type {number} - * @memberof IDownloadFromAzureFileOptions + * @memberof DownloadFromAzureFileOptions */ maxRetryRequestsPerBlock?: number; /** * Progress updater. * - * @memberof IDownloadFromBlobOptions + * @memberof DownloadFromBlobOptions */ progress?: (progress: TransferProgressEvent) => void; /** * Access conditions headers. * - * @type {IBlobAccessConditions} - * @memberof IDownloadFromBlobOptions + * @type {BlobAccessConditions} + * @memberof DownloadFromBlobOptions */ - blobAccessConditions?: IBlobAccessConditions; + blobAccessConditions?: BlobAccessConditions; /** * Concurrency of parallel download. * * @type {number} - * @memberof IDownloadFromBlobOptions + * @memberof DownloadFromBlobOptions */ parallelism?: number; } diff --git a/sdk/storage/storage-blob/src/highlevel.node.ts b/sdk/storage/storage-blob/src/highlevel.node.ts index c94132c126ec..6042e3765fdf 100644 --- a/sdk/storage/storage-blob/src/highlevel.node.ts +++ b/sdk/storage/storage-blob/src/highlevel.node.ts @@ -8,10 +8,10 @@ import { BlockBlobClient } from "./BlockBlobClient"; import { BlobHTTPHeaders } from "./generated/lib/models"; import { BlobUploadCommonResponse, - IDownloadFromBlobOptions, - IUploadToBlockBlobOptions + DownloadFromBlobOptions, + UploadToBlockBlobOptions } from "./highlevel.common"; -import { IBlobAccessConditions } from "./models"; +import { BlobAccessConditions } from "./models"; import { Batch } from "./utils/Batch"; import { BufferScheduler } from "./utils/BufferScheduler"; import { @@ -37,14 +37,14 @@ import { streamToBuffer } from "./utils/utils.node"; * goto documents of Aborter for more examples about request cancellation * @param {string} filePath Full path of local file * @param {BlockBlobClient} blockBlobClient BlockBlobClient - * @param {IUploadToBlockBlobOptions} [options] IUploadToBlockBlobOptions + * @param {UploadToBlockBlobOptions} [options] UploadToBlockBlobOptions * @returns {(Promise)} ICommonResponse */ export async function uploadFileToBlockBlob( aborter: Aborter, filePath: string, blockBlobClient: BlockBlobClient, - options?: IUploadToBlockBlobOptions + options?: UploadToBlockBlobOptions ): Promise { const size = fs.statSync(filePath).size; return uploadResetableStreamToBlockBlob( @@ -79,7 +79,7 @@ export async function uploadFileToBlockBlob( * from the offset defined * @param {number} size Size of the block blob * @param {BlockBlobClient} blockBlobClient BlockBlobClient - * @param {IUploadToBlockBlobOptions} [options] IUploadToBlockBlobOptions + * @param {UploadToBlockBlobOptions} [options] UploadToBlockBlobOptions * @returns {(Promise)} ICommonResponse */ async function uploadResetableStreamToBlockBlob( @@ -87,7 +87,7 @@ async function uploadResetableStreamToBlockBlob( streamFactory: (offset: number, count?: number) => NodeJS.ReadableStream, size: number, blockBlobClient: BlockBlobClient, - options: IUploadToBlockBlobOptions = {} + options: UploadToBlockBlobOptions = {} ): Promise { if (!options.blockSize) { options.blockSize = 0; @@ -188,7 +188,7 @@ async function uploadResetableStreamToBlockBlob( * @param {BlobClient} blobClient A BlobClient object * @param {number} offset From which position of the block blob to download * @param {number} [count] How much data to be downloaded. Will download to the end when passing undefined - * @param {IDownloadFromBlobOptions} [options] IDownloadFromBlobOptions + * @param {DownloadFromBlobOptions} [options] DownloadFromBlobOptions * @returns {Promise} */ export async function downloadBlobToBuffer( @@ -197,7 +197,7 @@ export async function downloadBlobToBuffer( blobClient: BlobClient, offset: number, count?: number, - options: IDownloadFromBlobOptions = {} + options: DownloadFromBlobOptions = {} ): Promise { if (!options.blockSize) { options.blockSize = 0; @@ -265,14 +265,14 @@ export async function downloadBlobToBuffer( * Option interface for uploadStreamToBlockBlob. * * @export - * @interface IUploadStreamToBlockBlobOptions + * @interface UploadStreamToBlockBlobOptions */ -export interface IUploadStreamToBlockBlobOptions { +export interface UploadStreamToBlockBlobOptions { /** * Blob HTTP Headers. * * @type {BlobHTTPHeaders} - * @memberof IUploadStreamToBlockBlobOptions + * @memberof UploadStreamToBlockBlobOptions */ blobHTTPHeaders?: BlobHTTPHeaders; @@ -280,22 +280,22 @@ export interface IUploadStreamToBlockBlobOptions { * Metadata of block blob. * * @type {{ [propertyName: string]: string }} - * @memberof IUploadStreamToBlockBlobOptions + * @memberof UploadStreamToBlockBlobOptions */ metadata?: { [propertyName: string]: string }; /** * Access conditions headers. * - * @type {IBlobAccessConditions} - * @memberof IUploadStreamToBlockBlobOptions + * @type {BlobAccessConditions} + * @memberof UploadStreamToBlockBlobOptions */ - accessConditions?: IBlobAccessConditions; + accessConditions?: BlobAccessConditions; /** * Progress updater. * - * @memberof IUploadStreamToBlockBlobOptions + * @memberof UploadStreamToBlockBlobOptions */ progress?: (progress: TransferProgressEvent) => void; } @@ -317,7 +317,7 @@ export interface IUploadStreamToBlockBlobOptions { * @param {number} bufferSize Size of every buffer allocated, also the block size in the uploaded block blob * @param {number} maxBuffers Max buffers will allocate during uploading, positive correlation * with max uploading concurrency - * @param {IUploadStreamToBlockBlobOptions} [options] + * @param {UploadStreamToBlockBlobOptions} [options] * @returns {Promise} */ export async function uploadStreamToBlockBlob( @@ -326,7 +326,7 @@ export async function uploadStreamToBlockBlob( blockBlobClient: BlockBlobClient, bufferSize: number, maxBuffers: number, - options: IUploadStreamToBlockBlobOptions = {} + options: UploadStreamToBlockBlobOptions = {} ): Promise { if (!options.blobHTTPHeaders) { options.blobHTTPHeaders = {}; diff --git a/sdk/storage/storage-blob/src/index.browser.ts b/sdk/storage/storage-blob/src/index.browser.ts index c0f086cec767..5ab7bb44b8ae 100644 --- a/sdk/storage/storage-blob/src/index.browser.ts +++ b/sdk/storage/storage-blob/src/index.browser.ts @@ -13,8 +13,8 @@ export * from "./credentials/Credential"; export * from "./credentials/TokenCredential"; export * from "./highlevel.browser"; export * from "./highlevel.common"; -export { IIPRange } from "./IIPRange"; -export { IRange } from "./IRange"; +export { IPRange } from "./IPRange"; +export { Range } from "./Range"; export * from "./PageBlobClient"; export * from "./Pipeline"; export * from "./policies/AnonymousCredentialPolicy"; diff --git a/sdk/storage/storage-blob/src/index.ts b/sdk/storage/storage-blob/src/index.ts index 5a8a07fd78f7..688a5a2ab408 100644 --- a/sdk/storage/storage-blob/src/index.ts +++ b/sdk/storage/storage-blob/src/index.ts @@ -6,10 +6,10 @@ export * from "./Aborter"; export * from "./AccountSASPermissions"; export * from "./AccountSASResourceTypes"; export * from "./AccountSASServices"; -export * from "./IAccountSASSignatureValues"; +export * from "./AccountSASSignatureValues"; export * from "./AppendBlobClient"; export * from "./BlobSASPermissions"; -export * from "./IBlobSASSignatureValues"; +export * from "./BlobSASSignatureValues"; export * from "./BlobClient"; export * from "./BlockBlobClient"; export * from "./BrowserPolicyFactory"; @@ -22,8 +22,8 @@ export * from "./credentials/TokenCredential"; export * from "./highlevel.browser"; export * from "./highlevel.common"; export * from "./highlevel.node"; -export { IIPRange } from "./IIPRange"; -export { IRange } from "./IRange"; +export { IPRange } from "./IPRange"; +export { Range } from "./Range"; export * from "./PageBlobClient"; export * from "./Pipeline"; export * from "./policies/AnonymousCredentialPolicy"; diff --git a/sdk/storage/storage-blob/src/models.ts b/sdk/storage/storage-blob/src/models.ts index 101f8ca9f7c4..7f95adacc903 100644 --- a/sdk/storage/storage-blob/src/models.ts +++ b/sdk/storage/storage-blob/src/models.ts @@ -1,23 +1,23 @@ import * as Models from "./generated/lib/models"; -export interface IMetadata { +export interface Metadata { [propertyName: string]: string; } -export interface IContainerAccessConditions { +export interface ContainerAccessConditions { modifiedAccessConditions?: Models.ModifiedAccessConditions; leaseAccessConditions?: Models.LeaseAccessConditions; } -export interface IBlobAccessConditions { +export interface BlobAccessConditions { modifiedAccessConditions?: Models.ModifiedAccessConditions; leaseAccessConditions?: Models.LeaseAccessConditions; } -export interface IPageBlobAccessConditions extends IBlobAccessConditions { +export interface PageBlobAccessConditions extends BlobAccessConditions { sequenceNumberAccessConditions?: Models.SequenceNumberAccessConditions; } -export interface IAppendBlobAccessConditions extends IBlobAccessConditions { +export interface AppendBlobAccessConditions extends BlobAccessConditions { appendPositionAccessConditions?: Models.AppendPositionAccessConditions; } diff --git a/sdk/storage/storage-blob/src/policies/LoggingPolicy.ts b/sdk/storage/storage-blob/src/policies/LoggingPolicy.ts index 0d1fa108a316..ca9ad64099d7 100644 --- a/sdk/storage/storage-blob/src/policies/LoggingPolicy.ts +++ b/sdk/storage/storage-blob/src/policies/LoggingPolicy.ts @@ -7,12 +7,12 @@ import { WebResource } from "@azure/ms-rest-js"; -import { IRequestLogOptions } from "../LoggingPolicyFactory"; +import { RequestLogOptions } from "../LoggingPolicyFactory"; import { HTTPURLConnection, URLConstants } from "../utils/constants"; import { getURLParameter, setURLParameter } from "../utils/utils.common"; -// Default values of IRetryOptions -const DEFAULT_REQUEST_LOG_OPTIONS: IRequestLogOptions = { +// Default values of RetryOptions +const DEFAULT_REQUEST_LOG_OPTIONS: RequestLogOptions = { logWarningIfTryOverThreshold: 3000 }; @@ -27,19 +27,19 @@ export class LoggingPolicy extends BaseRequestPolicy { private operationStartTime: Date = new Date(); private requestStartTime: Date = new Date(); - private readonly loggingOptions: IRequestLogOptions; + private readonly loggingOptions: RequestLogOptions; /** * Creates an instance of LoggingPolicy. * @param {RequestPolicy} nextPolicy * @param {RequestPolicyOptions} options - * @param {IRequestLogOptions} [loggingOptions=DEFAULT_REQUEST_LOG_OPTIONS] + * @param {RequestLogOptions} [loggingOptions=DEFAULT_REQUEST_LOG_OPTIONS] * @memberof LoggingPolicy */ constructor( nextPolicy: RequestPolicy, options: RequestPolicyOptions, - loggingOptions: IRequestLogOptions = DEFAULT_REQUEST_LOG_OPTIONS + loggingOptions: RequestLogOptions = DEFAULT_REQUEST_LOG_OPTIONS ) { super(nextPolicy, options); this.loggingOptions = loggingOptions; diff --git a/sdk/storage/storage-blob/src/policies/RetryPolicy.ts b/sdk/storage/storage-blob/src/policies/RetryPolicy.ts index 66252204f092..477f9aea9dd5 100644 --- a/sdk/storage/storage-blob/src/policies/RetryPolicy.ts +++ b/sdk/storage/storage-blob/src/policies/RetryPolicy.ts @@ -10,7 +10,7 @@ import { WebResource } from "@azure/ms-rest-js"; -import { IRetryOptions } from "../RetryPolicyFactory"; +import { RetryOptions } from "../RetryPolicyFactory"; import { URLConstants } from "../utils/constants"; import { setURLHost, setURLParameter } from "../utils/utils.common"; @@ -18,10 +18,10 @@ import { setURLHost, setURLParameter } from "../utils/utils.common"; * A factory method used to generated a RetryPolicy factory. * * @export - * @param {IRetryOptions} retryOptions + * @param {RetryOptions} retryOptions * @returns */ -export function NewRetryPolicyFactory(retryOptions?: IRetryOptions): RequestPolicyFactory { +export function NewRetryPolicyFactory(retryOptions?: RetryOptions): RequestPolicyFactory { return { create: (nextPolicy: RequestPolicy, options: RequestPolicyOptions): RetryPolicy => { return new RetryPolicy(nextPolicy, options, retryOptions); @@ -46,8 +46,8 @@ export enum RetryPolicyType { FIXED } -// Default values of IRetryOptions -const DEFAULT_RETRY_OPTIONS: IRetryOptions = { +// Default values of RetryOptions +const DEFAULT_RETRY_OPTIONS: RetryOptions = { maxRetryDelayInMs: 120 * 1000, maxTries: 4, retryDelayInMs: 4 * 1000, @@ -67,23 +67,23 @@ export class RetryPolicy extends BaseRequestPolicy { * RetryOptions. * * @private - * @type {IRetryOptions} + * @type {RetryOptions} * @memberof RetryPolicy */ - private readonly retryOptions: IRetryOptions; + private readonly retryOptions: RetryOptions; /** * Creates an instance of RetryPolicy. * * @param {RequestPolicy} nextPolicy * @param {RequestPolicyOptions} options - * @param {IRetryOptions} [retryOptions=DEFAULT_RETRY_OPTIONS] + * @param {RetryOptions} [retryOptions=DEFAULT_RETRY_OPTIONS] * @memberof RetryPolicy */ constructor( nextPolicy: RequestPolicy, options: RequestPolicyOptions, - retryOptions: IRetryOptions = DEFAULT_RETRY_OPTIONS + retryOptions: RetryOptions = DEFAULT_RETRY_OPTIONS ) { super(nextPolicy, options); diff --git a/sdk/storage/storage-blob/src/policies/TelemetryPolicy.ts b/sdk/storage/storage-blob/src/policies/TelemetryPolicy.ts index cedefe68fde4..2d324245209d 100644 --- a/sdk/storage/storage-blob/src/policies/TelemetryPolicy.ts +++ b/sdk/storage/storage-blob/src/policies/TelemetryPolicy.ts @@ -29,7 +29,7 @@ export class TelemetryPolicy extends BaseRequestPolicy { * Creates an instance of TelemetryPolicy. * @param {RequestPolicy} nextPolicy * @param {RequestPolicyOptions} options - * @param {ITelemetryOptions} [telemetry] + * @param {TelemetryOptions} [telemetry] * @memberof TelemetryPolicy */ constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, telemetry: string) { diff --git a/sdk/storage/storage-blob/src/utils/RetriableReadableStream.ts b/sdk/storage/storage-blob/src/utils/RetriableReadableStream.ts index 5bf8bec65096..a19afadcff5f 100644 --- a/sdk/storage/storage-blob/src/utils/RetriableReadableStream.ts +++ b/sdk/storage/storage-blob/src/utils/RetriableReadableStream.ts @@ -5,19 +5,19 @@ import { Aborter } from "../Aborter"; export type ReadableStreamGetter = (offset: number) => Promise; -export interface IRetriableReadableStreamOptions { +export interface RetriableReadableStreamOptions { /** * Max retry count (>=0), undefined or invalid value means no retry * * @type {number} - * @memberof IRetriableReadableStreamOptions + * @memberof RetriableReadableStreamOptions */ maxRetryRequests?: number; /** * Read progress event handler * - * @memberof IRetriableReadableStreamOptions + * @memberof RetriableReadableStreamOptions */ progress?: (progress: TransferProgressEvent) => void; @@ -31,7 +31,7 @@ export interface IRetriableReadableStreamOptions { * The value will then update to "undefined", once the injection works. * * @type {boolean} - * @memberof IRetriableReadableStreamOptions + * @memberof RetriableReadableStreamOptions */ doInjectErrorOnce?: boolean; } @@ -54,7 +54,7 @@ export class RetriableReadableStream extends Readable { private retries: number = 0; private maxRetryRequests: number; private progress?: (progress: TransferProgressEvent) => void; - private options: IRetriableReadableStreamOptions; + private options: RetriableReadableStreamOptions; /** * Creates an instance of RetriableReadableStream. @@ -66,7 +66,7 @@ export class RetriableReadableStream extends Readable { * a new ReadableStream from specified offset * @param {number} offset Offset position in original data source to read * @param {number} count How much data in original data source to read - * @param {IRetriableReadableStreamOptions} [options={}] + * @param {RetriableReadableStreamOptions} [options={}] * @memberof RetriableReadableStream */ public constructor( @@ -75,7 +75,7 @@ export class RetriableReadableStream extends Readable { getter: ReadableStreamGetter, offset: number, count: number, - options: IRetriableReadableStreamOptions = {} + options: RetriableReadableStreamOptions = {} ) { super(); this.aborter = aborter; diff --git a/sdk/storage/storage-blob/test/node/highlevel.node.spec.ts b/sdk/storage/storage-blob/test/node/highlevel.node.spec.ts index 1c79b37fdff8..8389565e5b8e 100644 --- a/sdk/storage/storage-blob/test/node/highlevel.node.spec.ts +++ b/sdk/storage/storage-blob/test/node/highlevel.node.spec.ts @@ -10,7 +10,7 @@ import { uploadFileToBlockBlob, uploadStreamToBlockBlob } from "../../src/highlevel.node"; -import { IRetriableReadableStreamOptions } from "../../src/utils/RetriableReadableStream"; +import { RetriableReadableStreamOptions } from "../../src/utils/RetriableReadableStream"; import { createRandomLocalFile, getBSU, getUniqueName, readStreamToLocalFile } from "../utils"; // tslint:disable:no-empty @@ -292,7 +292,7 @@ describe("Highlevel", () => { } ); - let retirableReadableStreamOptions: IRetriableReadableStreamOptions; + let retirableReadableStreamOptions: RetriableReadableStreamOptions; const downloadResponse = await blockBlobClient.download(Aborter.none, 0, undefined, { blobAccessConditions: { modifiedAccessConditions: { @@ -330,7 +330,7 @@ describe("Highlevel", () => { } ); - let retirableReadableStreamOptions: IRetriableReadableStreamOptions; + let retirableReadableStreamOptions: RetriableReadableStreamOptions; let injectedErrors = 0; const downloadResponse = await blockBlobClient.download(Aborter.none, 0, undefined, { blobAccessConditions: { @@ -371,7 +371,7 @@ describe("Highlevel", () => { const partialSize = 500 * 1024; - let retirableReadableStreamOptions: IRetriableReadableStreamOptions; + let retirableReadableStreamOptions: RetriableReadableStreamOptions; let injectedErrors = 0; const downloadResponse = await blockBlobClient.download(Aborter.none, 0, partialSize, { blobAccessConditions: { @@ -412,7 +412,7 @@ describe("Highlevel", () => { const downloadedFile = path.join(tempFolderPath, getUniqueName("downloadfile.")); - let retirableReadableStreamOptions: IRetriableReadableStreamOptions; + let retirableReadableStreamOptions: RetriableReadableStreamOptions; let injectedErrors = 0; let expectedError = false; @@ -453,7 +453,7 @@ describe("Highlevel", () => { const downloadedFile = path.join(tempFolderPath, getUniqueName("downloadfile.")); - let retirableReadableStreamOptions: IRetriableReadableStreamOptions; + let retirableReadableStreamOptions: RetriableReadableStreamOptions; let injectedErrors = 0; let expectedError = false; diff --git a/sdk/storage/storage-blob/test/utils/InjectorPolicy.ts b/sdk/storage/storage-blob/test/utils/InjectorPolicy.ts index 3d41732dcddb..735225b3334c 100644 --- a/sdk/storage/storage-blob/test/utils/InjectorPolicy.ts +++ b/sdk/storage/storage-blob/test/utils/InjectorPolicy.ts @@ -7,7 +7,7 @@ import { RestError } from "../../src"; -export interface INextInjectErrorHolder { +export interface NextInjectErrorHolder { nextInjectError?: RestError; } diff --git a/sdk/storage/storage-blob/tslint.json b/sdk/storage/storage-blob/tslint.json index ae2eb09109a7..498d029bd134 100644 --- a/sdk/storage/storage-blob/tslint.json +++ b/sdk/storage/storage-blob/tslint.json @@ -4,7 +4,8 @@ "jsRules": {}, "rules": { "trailing-comma": false, - "arrow-parens": false + "arrow-parens": false, + "interface-name": [true, "never-prefix"] }, "rulesDirectory": [], "linterOptions": {