From e82ee3ceb8a13b8b4fc62b9770d86929598e3984 Mon Sep 17 00:00:00 2001 From: Ramya Achutha Rao Date: Thu, 18 Feb 2021 18:08:18 -0800 Subject: [PATCH 1/2] [Storage] Follow TSDoc --- .../src/AvroReaderFactory.ts | 3 - .../src/BlobChangeFeedClient.ts | 33 +- .../storage-blob-changefeed/src/ChangeFeed.ts | 10 - .../storage-blob-changefeed/src/Chunk.ts | 6 - .../src/ChunkFactory.ts | 6 - .../src/LazyLoadingBlobStream.ts | 19 - .../storage-blob-changefeed/src/Segment.ts | 6 - .../src/SegmentFactory.ts | 6 - .../storage-blob-changefeed/src/Shard.ts | 6 - .../src/ShardFactory.ts | 6 - .../storage-blob-changefeed/src/log.ts | 2 +- .../src/models/BlobChangeFeedEvent.ts | 56 - .../src/models/models.ts | 12 - .../src/utils/tracing.ts | 4 +- .../src/utils/utils.browser.ts | 4 +- .../src/utils/utils.common.ts | 16 - .../src/utils/utils.node.ts | 4 +- .../test/utils/testutils.common.ts | 14 +- sdk/storage/storage-blob/src/BlobBatch.ts | 25 +- .../storage-blob/src/BlobBatchClient.ts | 24 +- .../storage-blob/src/BlobDownloadResponse.ts | 93 -- .../storage-blob/src/BlobLeaseClient.ts | 23 - .../src/BlobQueryResponse.browser.ts | 79 -- .../storage-blob/src/BlobQueryResponse.ts | 79 -- .../storage-blob/src/BlobServiceClient.ts | 182 +-- sdk/storage/storage-blob/src/Clients.ts | 1081 +---------------- .../storage-blob/src/ContainerClient.ts | 231 +--- .../storage-blob/src/PageBlobRangeResponse.ts | 2 +- sdk/storage/storage-blob/src/Pipeline.ts | 35 +- sdk/storage/storage-blob/src/Range.ts | 11 - .../src/StorageBrowserPolicyFactory.ts | 6 - sdk/storage/storage-blob/src/StorageClient.ts | 22 +- .../src/StorageRetryPolicyFactory.ts | 28 - .../src/TelemetryPolicyFactory.ts | 8 - .../src/credentials/AnonymousCredential.ts | 6 - .../src/credentials/Credential.ts | 6 - .../credentials/StorageSharedKeyCredential.ts | 15 - .../UserDelegationKeyCredential.ts | 16 - sdk/storage/storage-blob/src/log.ts | 2 +- sdk/storage/storage-blob/src/models.ts | 39 - .../src/policies/AnonymousCredentialPolicy.ts | 5 - .../src/policies/CredentialPolicy.ts | 11 - .../src/policies/StorageBrowserPolicy.ts | 6 - .../src/policies/StorageRetryPolicy.ts | 22 - .../StorageSharedKeyCredentialPolicy.ts | 20 - .../src/policies/TelemetryPolicy.ts | 9 - .../src/sas/AccountSASPermissions.ts | 77 -- .../src/sas/AccountSASResourceTypes.ts | 17 - .../src/sas/AccountSASServices.ts | 20 - .../src/sas/AccountSASSignatureValues.ts | 29 - .../src/sas/BlobSASPermissions.ts | 64 - .../src/sas/BlobSASSignatureValues.ts | 67 +- .../src/sas/ContainerSASPermissions.ts | 71 -- .../src/sas/SASQueryParameters.ts | 148 --- .../storage-blob/src/sas/SasIPRange.ts | 11 - sdk/storage/storage-blob/src/utils/Batch.ts | 42 - .../src/utils/BlobQuickQueryStream.ts | 11 - sdk/storage/storage-blob/src/utils/Mutex.ts | 9 - .../src/utils/RetriableReadableStream.ts | 17 +- sdk/storage/storage-blob/src/utils/tracing.ts | 4 +- .../storage-blob/src/utils/utils.browser.ts | 4 - .../storage-blob/src/utils/utils.common.ts | 42 +- .../storage-blob/src/utils/utils.node.ts | 12 +- .../storage-blob/test/utils/InjectorPolicy.ts | 6 - .../test/utils/InjectorPolicyFactory.ts | 4 - .../storage-blob/test/utils/index.browser.ts | 4 +- sdk/storage/storage-blob/test/utils/index.ts | 4 +- .../test/utils/testutils.common.ts | 12 +- .../storage-blob/test/utils/testutils.node.ts | 2 - .../storage-common/src/BufferScheduler.ts | 88 +- .../storage-common/src/BuffersStream.ts | 17 - .../storage-common/src/PooledBuffer.ts | 21 - .../src/dataLakeStorageClient.ts | 4 +- .../src/dataLakeStorageClientContext.ts | 4 +- .../storage-datalake/src/models/index.ts | 7 - .../src/operations/filesystemOperations.ts | 54 +- .../src/operations/pathOperations.ts | 138 +-- .../src/DataLakeFileSystemClient.ts | 47 +- .../src/DataLakeServiceClient.ts | 26 +- .../storage-file-datalake/src/Pipeline.ts | 37 +- .../src/StorageBrowserPolicyFactory.ts | 6 - .../src/StorageClient.ts | 32 +- .../src/StorageRetryPolicyFactory.ts | 28 - .../src/TelemetryPolicyFactory.ts | 8 - .../storage-file-datalake/src/clients.ts | 132 +- .../src/credentials/AnonymousCredential.ts | 6 - .../src/credentials/Credential.ts | 6 - .../credentials/StorageSharedKeyCredential.ts | 15 - .../UserDelegationKeyCredential.ts | 16 - sdk/storage/storage-file-datalake/src/log.ts | 2 +- .../storage-file-datalake/src/models.ts | 355 +----- .../src/policies/AnonymousCredentialPolicy.ts | 5 - .../src/policies/CredentialPolicy.ts | 11 - .../src/policies/StorageBrowserPolicy.ts | 6 - .../src/policies/StorageRetryPolicy.ts | 22 - .../StorageSharedKeyCredentialPolicy.ts | 20 - .../src/policies/TelemetryPolicy.ts | 9 - .../src/sas/AccountSASPermissions.ts | 32 - .../src/sas/AccountSASResourceTypes.ts | 17 - .../src/sas/AccountSASServices.ts | 20 - .../src/sas/AccountSASSignatureValues.ts | 29 - .../src/sas/DataLakeSASPermissions.ts | 34 - .../src/sas/DataLakeSASSignatureValues.ts | 73 +- .../src/sas/DirectorySASPermissions.ts | 38 - .../src/sas/FileSystemSASPermissions.ts | 38 - .../src/sas/SASQueryParameters.ts | 160 --- .../src/sas/SasIPRange.ts | 11 - .../storage-file-datalake/src/transforms.ts | 28 +- .../storage-file-datalake/src/utils/Batch.ts | 42 - .../src/utils/BufferScheduler.ts | 90 +- .../src/utils/DataLakeAclChangeFailedError.ts | 10 - .../src/utils/tracing.ts | 4 +- .../src/utils/utils.browser.ts | 4 - .../src/utils/utils.common.ts | 34 +- .../src/utils/utils.node.ts | 9 +- .../test/utils/InjectorPolicy.ts | 6 - .../test/utils/InjectorPolicyFactory.ts | 4 - .../test/utils/index.browser.ts | 4 +- .../storage-file-datalake/test/utils/index.ts | 4 +- .../test/utils/testutils.common.ts | 8 +- .../test/utils/testutils.node.ts | 2 - .../src/AccountSASPermissions.ts | 32 - .../src/AccountSASResourceTypes.ts | 17 - .../src/AccountSASServices.ts | 20 - .../src/AccountSASSignatureValues.ts | 29 - sdk/storage/storage-file-share/src/Clients.ts | 800 +----------- .../src/FileDownloadResponse.ts | 69 -- .../src/FileSASPermissions.ts | 19 - .../src/FileSASSignatureValues.ts | 47 - .../src/FileSystemAttributes.ts | 34 - .../storage-file-share/src/Pipeline.ts | 34 - sdk/storage/storage-file-share/src/Range.ts | 10 - .../src/SASQueryParameters.ts | 63 - .../storage-file-share/src/SasIPRange.ts | 10 - .../src/ShareClientInternal.ts | 3 - .../src/ShareSASPermissions.ts | 22 - .../src/ShareServiceClient.ts | 114 +- .../src/StorageBrowserPolicyFactory.ts | 6 - .../storage-file-share/src/StorageClient.ts | 17 - .../src/StorageRetryPolicyFactory.ts | 25 - .../src/TelemetryPolicyFactory.ts | 8 - .../src/credentials/AnonymousCredential.ts | 6 - .../src/credentials/Credential.ts | 6 - .../credentials/StorageSharedKeyCredential.ts | 15 - sdk/storage/storage-file-share/src/log.ts | 2 +- sdk/storage/storage-file-share/src/models.ts | 27 +- .../src/policies/AnonymousCredentialPolicy.ts | 5 - .../src/policies/CredentialPolicy.ts | 11 - .../src/policies/StorageBrowserPolicy.ts | 6 - .../src/policies/StorageRetryPolicy.ts | 22 - .../StorageSharedKeyCredentialPolicy.ts | 20 - .../src/policies/TelemetryPolicy.ts | 9 - .../storage-file-share/src/utils/Batch.ts | 42 - .../src/utils/BufferScheduler.ts | 90 +- .../src/utils/RetriableReadableStream.ts | 14 +- .../storage-file-share/src/utils/tracing.ts | 4 +- .../src/utils/utils.browser.ts | 2 - .../src/utils/utils.common.ts | 24 +- .../src/utils/utils.node.ts | 6 +- .../test/utils/InjectorPolicy.ts | 6 - .../test/utils/InjectorPolicyFactory.ts | 4 - .../test/utils/MockPolicy.ts | 6 - .../test/utils/MockPolicyFactory.ts | 4 - .../test/utils/index.browser.ts | 8 +- .../storage-file-share/test/utils/index.ts | 6 +- .../test/utils/testutils.node.ts | 2 - .../storage-internal-avro/src/AvroParser.ts | 14 - .../storage-internal-avro/src/AvroReadable.ts | 6 - .../storage-internal-avro/src/AvroReader.ts | 6 - .../src/AccountSASPermissions.ts | 32 - .../src/AccountSASResourceTypes.ts | 17 - .../storage-queue/src/AccountSASServices.ts | 20 - .../src/AccountSASSignatureValues.ts | 29 - sdk/storage/storage-queue/src/Pipeline.ts | 36 +- sdk/storage/storage-queue/src/QueueClient.ts | 168 +-- .../storage-queue/src/QueueSASPermissions.ts | 19 - .../src/QueueSASSignatureValues.ts | 29 - .../storage-queue/src/QueueServiceClient.ts | 77 +- .../storage-queue/src/SASQueryParameters.ts | 47 - sdk/storage/storage-queue/src/SasIPRange.ts | 11 - .../src/StorageBrowserPolicyFactory.ts | 6 - .../storage-queue/src/StorageClient.ts | 17 - .../src/StorageRetryPolicyFactory.ts | 28 - .../src/TelemetryPolicyFactory.ts | 8 - .../src/credentials/AnonymousCredential.ts | 6 - .../src/credentials/Credential.ts | 6 - .../credentials/StorageSharedKeyCredential.ts | 15 - sdk/storage/storage-queue/src/log.ts | 2 +- .../src/policies/AnonymousCredentialPolicy.ts | 5 - .../src/policies/CredentialPolicy.ts | 11 - .../src/policies/StorageBrowserPolicy.ts | 6 - .../src/policies/StorageRetryPolicy.ts | 23 - .../StorageSharedKeyCredentialPolicy.ts | 20 - .../src/policies/TelemetryPolicy.ts | 9 - .../storage-queue/src/utils/utils.common.ts | 14 +- .../test/utils/InjectorPolicy.ts | 6 - .../test/utils/InjectorPolicyFactory.ts | 4 - .../storage-queue/test/utils/index.browser.ts | 4 +- 198 files changed, 299 insertions(+), 6927 deletions(-) diff --git a/sdk/storage/storage-blob-changefeed/src/AvroReaderFactory.ts b/sdk/storage/storage-blob-changefeed/src/AvroReaderFactory.ts index 2ce4215133ae..ef66c17a26f4 100644 --- a/sdk/storage/storage-blob-changefeed/src/AvroReaderFactory.ts +++ b/sdk/storage/storage-blob-changefeed/src/AvroReaderFactory.ts @@ -5,9 +5,6 @@ import { AvroReadable, AvroReader } from "../../storage-internal-avro/src"; /** * Creates AvroReaders. Allows us to inject mock AvroReaders in the Chunk unit tests. - * - * @export - * @class AvroReaderFactory */ export class AvroReaderFactory { public create(headerAndDataStream: AvroReadable): AvroReader; diff --git a/sdk/storage/storage-blob-changefeed/src/BlobChangeFeedClient.ts b/sdk/storage/storage-blob-changefeed/src/BlobChangeFeedClient.ts index 1e6a7912f1ec..6b150ff7731c 100644 --- a/sdk/storage/storage-blob-changefeed/src/BlobChangeFeedClient.ts +++ b/sdk/storage/storage-blob-changefeed/src/BlobChangeFeedClient.ts @@ -18,24 +18,15 @@ import { TokenCredential } from "@azure/core-http"; /** * Contains paged response data for the {@link BlobChangeFeedClient.listChanges} operation. - * - * @export - * @class BlobChangeFeedEventPage */ export class BlobChangeFeedEventPage { /** * Array of {@link BlobChangeFeedEvent}. - * - * @type {BlobChangeFeedEvent[]} - * @memberof BlobChangeFeedEventPage */ public events: BlobChangeFeedEvent[]; /** * The token that keeps track of where to continue the iterator. - * - * @type {string} - * @memberof BlobChangeFeedEventPage */ public continuationToken: string; @@ -48,8 +39,7 @@ export class BlobChangeFeedEventPage { /** * Creates a new Pipeline object with Credential provided. * - * @export - * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. + * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. * @param pipelineOptions - Optional. Options. * @returns A new Pipeline object. */ @@ -80,17 +70,10 @@ function appendUserAgentPrefix(options?: StoragePipelineOptions): StoragePipelin /** * BlobChangeFeedClient. * @see https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-change-feed?tabs=azure-portal - * - * @export - * @class BlobChangeFeedClient */ export class BlobChangeFeedClient { /** - * blobServiceClient provided by @azure/storage-blob package. - * - * @private - * @type {BlobServiceClient} - * @memberof BlobChangeFeedClient + * blobServiceClient provided by `@azure/storage-blob` package. */ private blobServiceClient: BlobServiceClient; private changeFeedFactory: ChangeFeedFactory; @@ -106,7 +89,6 @@ export class BlobChangeFeedClient { * SAS connection string example - * `BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString` * @param options - Optional. Options to configure the HTTP pipeline. - * @memberof BlobChangeFeedClient */ public static fromConnectionString( connectionString: string, @@ -126,9 +108,8 @@ export class BlobChangeFeedClient { * @param url - A Client string pointing to Azure Storage blob service, such as * "https://myaccount.blob.core.windows.net". You can append a SAS * if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString". - * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. + * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. * @param options - Optional. Options to configure the HTTP pipeline. - * @memberof BlobChangeFeedClient * * Example using DefaultAzureCredential from `@azure/identity`: * @@ -169,7 +150,6 @@ export class BlobChangeFeedClient { * if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString". * @param pipeline - Call newPipeline() to create a default * pipeline, or provide a customized pipeline. - * @memberof BlobChangeFeedClient */ constructor(url: string, pipeline: Pipeline); constructor( @@ -324,7 +304,6 @@ export class BlobChangeFeedClient { * * @param options - Options to list change feed events. * @returns An asyncIterableIterator that supports paging. - * @memberof BlobChangeFeedClient */ public listChanges( options: BlobChangeFeedListChangesOptions = {} @@ -332,19 +311,19 @@ export class BlobChangeFeedClient { const iter = this.getChange(options); return { /** - * @member {Promise} [next] The next method, part of the iteration protocol + * The next method, part of the iteration protocol */ async next() { return iter.next(); }, /** - * @member {Symbol} [asyncIterator] The connection to the async iterator, part of the iteration protocol + * The connection to the async iterator, part of the iteration protocol */ [Symbol.asyncIterator]() { return this; }, /** - * @member {Function} [byPage] Return an AsyncIterableIterator that works a page at a time + * Return an AsyncIterableIterator that works a page at a time */ byPage: (settings: PageSettings = {}) => { return this.getPage(settings.continuationToken, settings.maxPageSize, options); diff --git a/sdk/storage/storage-blob-changefeed/src/ChangeFeed.ts b/sdk/storage/storage-blob-changefeed/src/ChangeFeed.ts index 0a7f9048770b..85cfe3fd6208 100644 --- a/sdk/storage/storage-blob-changefeed/src/ChangeFeed.ts +++ b/sdk/storage/storage-blob-changefeed/src/ChangeFeed.ts @@ -13,17 +13,11 @@ import { CanonicalCode } from "@opentelemetry/api"; /** * Options to configure {@link ChangeFeed.getChange} operation. - * - * @export - * @interface ChangeFeedGetChangeOptions */ export interface ChangeFeedGetChangeOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ChangeFeedGetChangeOptions */ abortSignal?: AbortSignalLike; } @@ -31,10 +25,6 @@ export interface ChangeFeedGetChangeOptions extends CommonOptions { export class ChangeFeed { /** * BlobContainerClient for making List Blob requests and creating Segments. - * - * @private - * @type {ContainerClient} - * @memberof ChangeFeed */ private readonly containerClient?: ContainerClient; diff --git a/sdk/storage/storage-blob-changefeed/src/Chunk.ts b/sdk/storage/storage-blob-changefeed/src/Chunk.ts index 23e4ce24788c..044bb4f0290b 100644 --- a/sdk/storage/storage-blob-changefeed/src/Chunk.ts +++ b/sdk/storage/storage-blob-changefeed/src/Chunk.ts @@ -9,17 +9,11 @@ import { AvroParseOptions } from "../../storage-internal-avro/src/AvroReader"; /** * Options to configure {@link Chunk.getChange} operation. - * - * @export - * @interface ChunkGetChangeOptions */ export interface ChunkGetChangeOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ChunkGetChangeOptions */ abortSignal?: AbortSignalLike; } diff --git a/sdk/storage/storage-blob-changefeed/src/ChunkFactory.ts b/sdk/storage/storage-blob-changefeed/src/ChunkFactory.ts index 1d10d76f023c..1dc8b3595be7 100644 --- a/sdk/storage/storage-blob-changefeed/src/ChunkFactory.ts +++ b/sdk/storage/storage-blob-changefeed/src/ChunkFactory.ts @@ -12,17 +12,11 @@ import { CHANGE_FEED_CHUNK_BLOCK_DOWNLOAD_SIZE } from "./utils/constants"; /** * Options to configure {@link ChunkFactory.create} operation. - * - * @export - * @interface CreateChunkOptions */ export interface CreateChunkOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof CreateChunkOptions */ abortSignal?: AbortSignalLike; } diff --git a/sdk/storage/storage-blob-changefeed/src/LazyLoadingBlobStream.ts b/sdk/storage/storage-blob-changefeed/src/LazyLoadingBlobStream.ts index d3120e869dc5..2d854c35f3ed 100644 --- a/sdk/storage/storage-blob-changefeed/src/LazyLoadingBlobStream.ts +++ b/sdk/storage/storage-blob-changefeed/src/LazyLoadingBlobStream.ts @@ -14,9 +14,6 @@ export interface LazyLoadingBlobStreamOptions extends ReadableOptions, CommonOpt /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof LazyLoadingBlobStreamOptions */ abortSignal?: AbortSignalLike; } @@ -25,35 +22,21 @@ interface LazyLoadingBlobStreamDownloadBlockOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof LazyLoadingBlobStreamDownloadBlockOptions */ abortSignal?: AbortSignalLike; } /** * This class generates a readable stream from a blobClient's data. - * - * @export - * @class LazyLoadingBlobStream */ export class LazyLoadingBlobStream extends Readable { /** * BlobClient to make download calls with. - * - * @private - * @type {BlobClient} - * @memberof LazyLoadingBlobStream */ private readonly blobClient: BlobClient; /** * The offset within the blob of the next block we will download. - * - * @private - * @type {number} - * @memberof LazyLoadingBlobStream */ private offset: number; @@ -71,7 +54,6 @@ export class LazyLoadingBlobStream extends Readable { * Creates an instance of LazyLoadingBlobStream. * * @param byteLength - The total length of data contained in the buffers - * @memberof LazyLoadingBlobStream */ constructor( blobClient: BlobClient, @@ -130,7 +112,6 @@ export class LazyLoadingBlobStream extends Readable { * Internal _read() that will be called when the stream wants to pull more data in. * * @param size - Optional. The size of data to be read - * @memberof LazyLoadingBlobStream */ public async _read(size?: number) { const { span, spanOptions } = createSpan( diff --git a/sdk/storage/storage-blob-changefeed/src/Segment.ts b/sdk/storage/storage-blob-changefeed/src/Segment.ts index ef2bf923a985..f27c8a947590 100644 --- a/sdk/storage/storage-blob-changefeed/src/Segment.ts +++ b/sdk/storage/storage-blob-changefeed/src/Segment.ts @@ -11,17 +11,11 @@ import { CanonicalCode } from "@opentelemetry/api"; /** * Options to configure {@link Segment.getChange} operation. - * - * @export - * @interface SegmentGetChangeOptions */ export interface SegmentGetChangeOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof SegmentGetChangeOptions */ abortSignal?: AbortSignalLike; } diff --git a/sdk/storage/storage-blob-changefeed/src/SegmentFactory.ts b/sdk/storage/storage-blob-changefeed/src/SegmentFactory.ts index c88dae9fc301..737c761fac0d 100644 --- a/sdk/storage/storage-blob-changefeed/src/SegmentFactory.ts +++ b/sdk/storage/storage-blob-changefeed/src/SegmentFactory.ts @@ -24,17 +24,11 @@ export interface SegmentManifest { /** * Options to configure {@link SegmentFactory.create} operation. - * - * @export - * @interface CreateSegmentOptions */ export interface CreateSegmentOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof CreateSegmentOptions */ abortSignal?: AbortSignalLike; } diff --git a/sdk/storage/storage-blob-changefeed/src/Shard.ts b/sdk/storage/storage-blob-changefeed/src/Shard.ts index 590073d1de09..15360b672a7c 100644 --- a/sdk/storage/storage-blob-changefeed/src/Shard.ts +++ b/sdk/storage/storage-blob-changefeed/src/Shard.ts @@ -12,17 +12,11 @@ import { CanonicalCode } from "@opentelemetry/api"; /** * Options to configure {@link Shard.getChange} operation. - * - * @export - * @interface ShardGetChangeOptions */ export interface ShardGetChangeOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ShardGetChangeOptions */ abortSignal?: AbortSignalLike; } diff --git a/sdk/storage/storage-blob-changefeed/src/ShardFactory.ts b/sdk/storage/storage-blob-changefeed/src/ShardFactory.ts index 917cb6171e16..691ed1fc19bd 100644 --- a/sdk/storage/storage-blob-changefeed/src/ShardFactory.ts +++ b/sdk/storage/storage-blob-changefeed/src/ShardFactory.ts @@ -12,17 +12,11 @@ import { createSpan } from "./utils/tracing"; /** * Options to configure {@link ShardFactory.create} operation. - * - * @export - * @interface CreateShardOptions */ export interface CreateShardOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof CreateShardOptions */ abortSignal?: AbortSignalLike; } diff --git a/sdk/storage/storage-blob-changefeed/src/log.ts b/sdk/storage/storage-blob-changefeed/src/log.ts index 9391e9b59998..3770275b8b8c 100644 --- a/sdk/storage/storage-blob-changefeed/src/log.ts +++ b/sdk/storage/storage-blob-changefeed/src/log.ts @@ -4,6 +4,6 @@ import { createClientLogger } from "@azure/logger"; /** - * The @azure/logger configuration for this package. + * The `@azure/logger` configuration for this package. */ export const logger = createClientLogger("storage-blob-changefeed"); diff --git a/sdk/storage/storage-blob-changefeed/src/models/BlobChangeFeedEvent.ts b/sdk/storage/storage-blob-changefeed/src/models/BlobChangeFeedEvent.ts index fdf485193cc6..6c8db5852b80 100644 --- a/sdk/storage/storage-blob-changefeed/src/models/BlobChangeFeedEvent.ts +++ b/sdk/storage/storage-blob-changefeed/src/models/BlobChangeFeedEvent.ts @@ -20,72 +20,45 @@ export type BlobChangeFeedEventType = /** * Change feed event record. Contains response data for the {@link BlobChangeFeedClient.listChanges} operation. * @see https://docs.microsoft.com/en-us/azure/event-grid/event-schema-blob-storage?toc=/azure/storage/blobs/toc.json#event-properties - * - * @export - * @interface BlobChangeFeedEvent */ export interface BlobChangeFeedEvent { /** * Full resource path to the event source. This field is not writeable. Event Grid provides this value. - * - * @type {string} - * @memberof BlobChangeFeedEvent */ topic: string; /** * Publisher-defined path to the event subject. - * - * @type {string} - * @memberof BlobChangeFeedEvent */ subject: string; /** * One of the registered event types for this event source. - * - * @type {BlobChangeFeedEventType} - * @memberof BlobChangeFeedEvent */ eventType: BlobChangeFeedEventType; /** * The time the event is generated based on the provider's UTC time. - * - * @type {Date} - * @memberof BlobChangeFeedEvent */ eventTime: Date; /** * Unique identifier for the event. - * - * @type {string} - * @memberof BlobChangeFeedEvent */ id: string; // GUID /** * Blob storage event data. - * - * @type {BlobChangeFeedEventData} - * @memberof BlobChangeFeedEvent */ data: BlobChangeFeedEventData; /** * The schema version of the data object. The publisher defines the schema version. - * - * @type {string} - * @memberof BlobChangeFeedEvent */ dataVersion?: string; /** * The schema version of the event metadata. Event Grid defines the schema of the top-level properties. Event Grid provides this value. - * - * @type {string} - * @memberof BlobChangeFeedEvent */ metadataVersion: string; } @@ -97,16 +70,10 @@ export type BlobType = "BlockBlob" | "AppendBlob" | "PageBlob"; /** * Change feed Blob storage event data. - * - * @export - * @interface BlobChangeFeedEventData */ export interface BlobChangeFeedEventData { /** * The operation that triggered the event. - * - * @type {string} - * @memberof BlobChangeFeedEventData */ api: string; @@ -114,9 +81,6 @@ export interface BlobChangeFeedEventData { * A client-provided request id for the storage API operation. This id can be used to * correlate to Azure Storage diagnostic logs using the "client-request-id" field in the logs, * and can be provided in client requests using the "x-ms-client-request-id" header. - * - * @type {string} - * @memberof BlobChangeFeedEventData */ clientRequestId: string; // GUID @@ -124,58 +88,38 @@ export interface BlobChangeFeedEventData { * Service-generated request id for the storage API operation. Can be used to correlate to Azure Storage * diagnostic logs using the "request-id-header" field in the logs and is returned from initiating API call * in the 'x-ms-request-id' header. - * @type {string} - * @memberof BlobChangeFeedEventData */ requestId: string; // GUID /** * The value that you can use to perform operations conditionally. - * - * @type {string} - * @memberof BlobChangeFeedEventData */ etag: string; /** * The content type specified for the blob. - * - * @type {string} - * @memberof BlobChangeFeedEventData */ contentType: string; /** * The size of the blob in bytes. - * - * @type {number} - * @memberof BlobChangeFeedEventData */ contentLength: number; /** * The type of blob. - * - * @type {BlobType} - * @memberof BlobChangeFeedEventData */ blobType: BlobType; /** * The path to the blob. If the client uses a Blob REST API, then the url has this structure: * .blob.core.windows.net//. - * - * @type {string} - * @memberof BlobChangeFeedEventData */ url: string; /** * An opaque string value representing the logical sequence of events for any particular blob name. * Users can use standard string comparison to understand the relative sequence of two events on the same blob name. - * - * @type {string} - * @memberof BlobChangeFeedEventData */ sequencer: string; } diff --git a/sdk/storage/storage-blob-changefeed/src/models/models.ts b/sdk/storage/storage-blob-changefeed/src/models/models.ts index 1daf144a157e..cbf771cbfa13 100644 --- a/sdk/storage/storage-blob-changefeed/src/models/models.ts +++ b/sdk/storage/storage-blob-changefeed/src/models/models.ts @@ -6,35 +6,23 @@ import { AbortSignalLike } from "@azure/core-http"; /** * Options to configure {@link BlobChangeFeedClient.listChanges} operation. - * - * @export - * @interface BlobChangeFeedListChangesOptions */ export interface BlobChangeFeedListChangesOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlobChangeFeedListChangesOptions */ abortSignal?: AbortSignalLike; /** * Specify the start of the time range during which the change feed records will be fetched. * Note that for now the change feed client will round start time down to the nearest hour. - * - * @type {Date} - * @memberof BlobChangeFeedListChangesOptions */ start?: Date; /** * Specify the end of the time range during which the change feed records will be fetched. * Note that for now the change feed client will round end time up to the nearest hour. - * - * @type {Date} - * @memberof BlobChangeFeedListChangesOptions */ end?: Date; } diff --git a/sdk/storage/storage-blob-changefeed/src/utils/tracing.ts b/sdk/storage/storage-blob-changefeed/src/utils/tracing.ts index 5a36fc6f8ce9..881f79f84d93 100644 --- a/sdk/storage/storage-blob-changefeed/src/utils/tracing.ts +++ b/sdk/storage/storage-blob-changefeed/src/utils/tracing.ts @@ -6,8 +6,8 @@ import { Span, SpanOptions as OTSpanOptions, SpanKind } from "@opentelemetry/api /** * Creates a span using the global tracer. - * @param name The name of the operation being performed. - * @param tracingOptions The options for the underlying http request. + * @param name - The name of the operation being performed. + * @param tracingOptions - The options for the underlying http request. */ export function createSpan( operationName: string, diff --git a/sdk/storage/storage-blob-changefeed/src/utils/utils.browser.ts b/sdk/storage/storage-blob-changefeed/src/utils/utils.browser.ts index 4a20fbc48faa..fa03e79d70be 100644 --- a/sdk/storage/storage-blob-changefeed/src/utils/utils.browser.ts +++ b/sdk/storage/storage-blob-changefeed/src/utils/utils.browser.ts @@ -5,8 +5,8 @@ * Read body from downloading operation methods to string. * Works in both Node.js and browsers. * - * @param response Convenience layer methods response with downloaded body - * @param length Length of Readable stream, needed for Node.js environment + * @param response - Convenience layer methods response with downloaded body + * @param length - Length of Readable stream, needed for Node.js environment */ export async function bodyToString( response: { diff --git a/sdk/storage/storage-blob-changefeed/src/utils/utils.common.ts b/sdk/storage/storage-blob-changefeed/src/utils/utils.common.ts index 54aa000c3de2..576c6a4aa645 100644 --- a/sdk/storage/storage-blob-changefeed/src/utils/utils.common.ts +++ b/sdk/storage/storage-blob-changefeed/src/utils/utils.common.ts @@ -25,9 +25,7 @@ export function floorToNearestHour(date: Date | undefined): Date | undefined { /** * Get host from an URL string. * - * @export * @param url - Source URL string - * */ export function getHost(url: string): string | undefined { const urlParsed = URLBuilder.parse(url); @@ -37,9 +35,7 @@ export function getHost(url: string): string | undefined { /** * Get URI from an URL string. * - * @export * @param url - Source URL string - * */ export function getURI(url: string): string { const urlParsed = URLBuilder.parse(url); @@ -58,17 +54,11 @@ export function hashString(str: string): number { /** * Options to configure {@link getYearsPaths} operation. - * - * @export - * @interface GetYearsPathsOptions */ export interface GetYearsPathsOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof GetYearsPathsOptions */ abortSignal?: AbortSignalLike; } @@ -105,17 +95,11 @@ export async function getYearsPaths( /** * Options to configure {@link getSegmentsInYear} operation. - * - * @export - * @interface GetSegmentsInYearOptions */ export interface GetSegmentsInYearOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof GetSegmentsInYearOptions */ abortSignal?: AbortSignalLike; } diff --git a/sdk/storage/storage-blob-changefeed/src/utils/utils.node.ts b/sdk/storage/storage-blob-changefeed/src/utils/utils.node.ts index 84d77700ee5b..75fe82697e01 100644 --- a/sdk/storage/storage-blob-changefeed/src/utils/utils.node.ts +++ b/sdk/storage/storage-blob-changefeed/src/utils/utils.node.ts @@ -7,8 +7,8 @@ import { AvroReadable, AvroReadableFromStream } from "../../../storage-internal- * Read body from downloading operation methods to string. * Works in both Node.js and browsers. * - * @param response Convenience layer methods response with downloaded body - * @param length Length of Readable stream, needed for Node.js environment + * @param response - Convenience layer methods response with downloaded body + * @param length - Length of Readable stream, needed for Node.js environment */ export async function bodyToString( response: { diff --git a/sdk/storage/storage-blob-changefeed/test/utils/testutils.common.ts b/sdk/storage/storage-blob-changefeed/test/utils/testutils.common.ts index 80e9ac944a7c..8359414fb0c3 100644 --- a/sdk/storage/storage-blob-changefeed/test/utils/testutils.common.ts +++ b/sdk/storage/storage-blob-changefeed/test/utils/testutils.common.ts @@ -80,8 +80,8 @@ export class SimpleTokenCredential implements TokenCredential { /** * Retrieves the token stored in this RawTokenCredential. * - * @param _scopes Ignored since token is already known. - * @param _options Ignored since token is already known. + * @param _scopes - Ignored since token is already known. + * @param _options - Ignored since token is already known. * @returns The access token details. */ async getToken( @@ -120,8 +120,8 @@ type BlobMetadata = { [propertyName: string]: string }; /** * Validate if m1 is super set of m2. * - * @param m1 BlobMetadata - * @param m2 BlobMetadata + * @param m1 - BlobMetadata + * @param m2 - BlobMetadata */ export function isSuperSet(m1?: BlobMetadata, m2?: BlobMetadata): boolean { if (!m1 || !m2) { @@ -140,9 +140,7 @@ export function isSuperSet(m1?: BlobMetadata, m2?: BlobMetadata): boolean { /** * Sleep for seconds. * - * @export * @param seconds - - * */ export function sleep(seconds: number): Promise { return new Promise((resolve) => { @@ -153,11 +151,9 @@ export function sleep(seconds: number): Promise { /** * String.prototype.padStart() * - * @export * @param currentString - * @param targetLength - - * @param [padString=" - "] - * + * @param padString - */ export function padStart( currentString: string, diff --git a/sdk/storage/storage-blob/src/BlobBatch.ts b/sdk/storage/storage-blob/src/BlobBatch.ts index c840c05fed4e..58bb53b0d437 100644 --- a/sdk/storage/storage-blob/src/BlobBatch.ts +++ b/sdk/storage/storage-blob/src/BlobBatch.ts @@ -39,19 +39,13 @@ import { createSpan } from "./utils/tracing"; export interface BatchSubRequest { /** * The URL of the resource to request operation. - * - * @type {string} - * @memberof BatchSubRequest */ url: string; /** * The credential used for sub request. - * Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. + * Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. * You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. - * - * @type {StorageSharedKeyCredential | AnonymousCredential | TokenCredential} - * @memberof BatchSubRequest */ credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential; } @@ -59,9 +53,6 @@ export interface BatchSubRequest { /** * A BlobBatch represents an aggregated set of operations on blobs. * Currently, only `delete` and `setAccessTier` are supported. - * - * @export - * @class BlobBatch */ export class BlobBatch { private batchRequest: InnerBatchRequest; @@ -132,10 +123,8 @@ export class BlobBatch { * See [blob batch authorization details](https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization). * * @param url - The url of the blob resource to delete. - * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. + * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. * @param options - - * - * @memberof BlobBatch */ public async deleteBlob( url: string, @@ -155,8 +144,6 @@ export class BlobBatch { * * @param blobClient - The BlobClient. * @param options - - * - * @memberof BlobBatch */ public async deleteBlob(blobClient: BlobClient, options?: BlobDeleteOptions): Promise; @@ -240,11 +227,9 @@ export class BlobBatch { * with specified credential. See [blob batch authorization details](https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization). * * @param url - The url of the blob resource to delete. - * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. + * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. * @param tier - * @param options - - * - * @memberof BlobBatch */ public async setBlobAccessTier( url: string, @@ -268,8 +253,6 @@ export class BlobBatch { * @param blobClient - The BlobClient. * @param tier - * @param options - - * - * @memberof BlobBatch */ public async setBlobAccessTier( blobClient: BlobClient, @@ -392,7 +375,7 @@ class InnerBatchRequest { * credential and serialization/deserialization components, with additional policies to * filter unnecessary headers, assemble sub requests into request's body * and intercept request from going to wire. - * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. + * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. */ public createPipeline( credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential diff --git a/sdk/storage/storage-blob/src/BlobBatchClient.ts b/sdk/storage/storage-blob/src/BlobBatchClient.ts index c0da4b3d5577..f07644c6e7b6 100644 --- a/sdk/storage/storage-blob/src/BlobBatchClient.ts +++ b/sdk/storage/storage-blob/src/BlobBatchClient.ts @@ -26,9 +26,6 @@ import { getURLPath } from "./utils/utils.common"; /** * Options to configure the Service - Submit Batch Optional Params. - * - * @export - * @interface BlobBatchSubmitBatchOptionalParams */ export interface BlobBatchSubmitBatchOptionalParams extends ServiceSubmitBatchOptionalParamsModel, @@ -36,9 +33,6 @@ export interface BlobBatchSubmitBatchOptionalParams /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlobBatchSubmitBatchOptionalParams */ abortSignal?: AbortSignalLike; } @@ -83,9 +77,8 @@ export class BlobBatchClient { * @param url - A url pointing to Azure Storage blob service, such as * "https://myaccount.blob.core.windows.net". You can append a SAS * if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString". - * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. + * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. * @param options - Options to configure the HTTP pipeline. - * @memberof BlobBatchClient */ constructor( url: string, @@ -100,7 +93,6 @@ export class BlobBatchClient { * if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString". * @param pipeline - Call newPipeline() to create a default * pipeline, or provide a customized pipeline. - * @memberof BlobBatchClient */ constructor(url: string, pipeline: Pipeline); constructor( @@ -149,10 +141,8 @@ export class BlobBatchClient { * See [blob batch authorization details](https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization). * * @param urls - The urls of the blob resources to delete. - * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. + * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. * @param options - - * - * @memberof BlobBatchClient */ public async deleteBlobs( urls: string[], @@ -169,8 +159,6 @@ export class BlobBatchClient { * * @param blobClients - The BlobClients for the blobs to delete. * @param options - - * - * @memberof BlobBatchClient */ public async deleteBlobs( blobClients: BlobClient[], @@ -210,11 +198,9 @@ export class BlobBatchClient { * with specified credential.See [blob batch authorization details](https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization). * * @param urls - The urls of the blob resource to delete. - * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. + * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. * @param tier - * @param options - - * - * @memberof BlobBatchClient */ public async setBlobsAccessTier( urls: string[], @@ -237,8 +223,6 @@ export class BlobBatchClient { * @param blobClients - The BlobClients for the blobs which should have a new tier set. * @param tier - * @param options - - * - * @memberof BlobBatchClient */ public async setBlobsAccessTier( blobClients: BlobClient[], @@ -310,8 +294,6 @@ export class BlobBatchClient { * * @param batchRequest - A set of Delete or SetTier operations. * @param options - - * - * @memberof BlobBatchClient */ public async submitBatch( batchRequest: BlobBatch, diff --git a/sdk/storage/storage-blob/src/BlobDownloadResponse.ts b/sdk/storage/storage-blob/src/BlobDownloadResponse.ts index 03158ea1b2d0..cda5fd2f2726 100644 --- a/sdk/storage/storage-blob/src/BlobDownloadResponse.ts +++ b/sdk/storage/storage-blob/src/BlobDownloadResponse.ts @@ -26,10 +26,6 @@ import { * * The {@link readableStreamBody} stream will retry underlayer, you can just use it as a normal Node.js * Readable stream. - * - * @export - * @class BlobDownloadResponse - * @implements {BlobDownloadResponseParsed} */ export class BlobDownloadResponse implements BlobDownloadResponseParsed { /** @@ -37,8 +33,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * requests for partial file content. * * @readonly - * @type {(string | undefined)} - * @memberof BlobDownloadResponse */ public get acceptRanges(): string | undefined { return this.originalResponse.acceptRanges; @@ -49,8 +43,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * for the file. * * @readonly - * @type {(string | undefined)} - * @memberof BlobDownloadResponse */ public get cacheControl(): string | undefined { return this.originalResponse.cacheControl; @@ -62,8 +54,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * response. * * @readonly - * @type {(string | undefined)} - * @memberof BlobDownloadResponse */ public get contentDisposition(): string | undefined { return this.originalResponse.contentDisposition; @@ -74,8 +64,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * for the Content-Encoding request header. * * @readonly - * @type {(string | undefined)} - * @memberof BlobDownloadResponse */ public get contentEncoding(): string | undefined { return this.originalResponse.contentEncoding; @@ -86,8 +74,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * for the Content-Language request header. * * @readonly - * @type {(string | undefined)} - * @memberof BlobDownloadResponse */ public get contentLanguage(): string | undefined { return this.originalResponse.contentLanguage; @@ -98,8 +84,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * page blob. This header is not returned for block blobs or append blobs. * * @readonly - * @type {(number | undefined)} - * @memberof BlobDownloadResponse */ public get blobSequenceNumber(): number | undefined { return this.originalResponse.blobSequenceNumber; @@ -110,8 +94,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * 'BlockBlob', 'PageBlob', 'AppendBlob'. * * @readonly - * @type {(BlobType | undefined)} - * @memberof BlobDownloadResponse */ public get blobType(): BlobType | undefined { return this.originalResponse.blobType; @@ -122,8 +104,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * response body. * * @readonly - * @type {(number | undefined)} - * @memberof BlobDownloadResponse */ public get contentLength(): number | undefined { return this.originalResponse.contentLength; @@ -140,8 +120,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * header. * * @readonly - * @type {(Uint8Array | undefined)} - * @memberof BlobDownloadResponse */ public get contentMD5(): Uint8Array | undefined { return this.originalResponse.contentMD5; @@ -153,8 +131,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * header. * * @readonly - * @type {(string | undefined)} - * @memberof BlobDownloadResponse */ public get contentRange(): string | undefined { return this.originalResponse.contentRange; @@ -165,8 +141,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * The default content type is 'application/octet-stream' * * @readonly - * @type {(string | undefined)} - * @memberof BlobDownloadResponse */ public get contentType(): string | undefined { return this.originalResponse.contentType; @@ -178,8 +152,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * can specify the time of a completed, aborted, or failed copy attempt. * * @readonly - * @type {(Date | undefined)} - * @memberof BlobDownloadResponse */ public get copyCompletedOn(): Date | undefined { return this.originalResponse.copyCompletedOn; @@ -190,8 +162,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * File operation where this file was the destination file. * * @readonly - * @type {(string | undefined)} - * @memberof BlobDownloadResponse */ public get copyId(): string | undefined { return this.originalResponse.copyId; @@ -204,8 +174,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * Content-Length bytes copied. * * @readonly - * @type {(string | undefined)} - * @memberof BlobDownloadResponse */ public get copyProgress(): string | undefined { return this.originalResponse.copyProgress; @@ -217,8 +185,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * was the destination file. * * @readonly - * @type {(string | undefined)} - * @memberof BlobDownloadResponse */ public get copySource(): string | undefined { return this.originalResponse.copySource; @@ -230,8 +196,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * 'success', 'aborted', 'failed' * * @readonly - * @type {(CopyStatusType | undefined)} - * @memberof BlobDownloadResponse */ public get copyStatus(): CopyStatusType | undefined { return this.originalResponse.copyStatus; @@ -243,8 +207,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * non-fatal copy operation failure. * * @readonly - * @type {(string | undefined)} - * @memberof BlobDownloadResponse */ public get copyStatusDescription(): string | undefined { return this.originalResponse.copyStatusDescription; @@ -256,8 +218,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * values include: 'infinite', 'fixed'. * * @readonly - * @type {(LeaseDurationType | undefined)} - * @memberof BlobDownloadResponse */ public get leaseDuration(): LeaseDurationType | undefined { return this.originalResponse.leaseDuration; @@ -268,8 +228,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * values include: 'available', 'leased', 'expired', 'breaking', 'broken'. * * @readonly - * @type {(LeaseStateType | undefined)} - * @memberof BlobDownloadResponse */ public get leaseState(): LeaseStateType | undefined { return this.originalResponse.leaseState; @@ -280,8 +238,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * blob. Possible values include: 'locked', 'unlocked'. * * @readonly - * @type {(LeaseStatusType | undefined)} - * @memberof BlobDownloadResponse */ public get leaseStatus(): LeaseStatusType | undefined { return this.originalResponse.leaseStatus; @@ -292,8 +248,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * indicates the time at which the response was initiated. * * @readonly - * @type {(Date | undefined)} - * @memberof BlobDownloadResponse */ public get date(): Date | undefined { return this.originalResponse.date; @@ -304,8 +258,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * present in the blob. This header is returned only for append blobs. * * @readonly - * @type {(number | undefined)} - * @memberof BlobDownloadResponse */ public get blobCommittedBlockCount(): number | undefined { return this.originalResponse.blobCommittedBlockCount; @@ -316,8 +268,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * perform operations conditionally, in quotes. * * @readonly - * @type {(string | undefined)} - * @memberof BlobDownloadResponse */ public get etag(): string | undefined { return this.originalResponse.etag; @@ -327,8 +277,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * The number of tags associated with the blob * * @readonly - * @type {(number | undefined)} - * @memberof BlobDownloadResponse */ public get tagCount(): number | undefined { return this.originalResponse.tagCount; @@ -338,8 +286,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * The error code. * * @readonly - * @type {(string | undefined)} - * @memberof BlobDownloadResponse */ public get errorCode(): string | undefined { return this.originalResponse.errorCode; @@ -353,8 +299,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * are encrypted). * * @readonly - * @type {(boolean | undefined)} - * @memberof BlobDownloadResponse */ public get isServerEncrypted(): boolean | undefined { return this.originalResponse.isServerEncrypted; @@ -368,8 +312,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * latter calculated from the requested range. * * @readonly - * @type {(Uint8Array | undefined)} - * @memberof BlobDownloadResponse */ public get blobContentMD5(): Uint8Array | undefined { return this.originalResponse.blobContentMD5; @@ -381,8 +323,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * the last modified time. * * @readonly - * @type {(Date | undefined)} - * @memberof BlobDownloadResponse */ public get lastModified(): Date | undefined { return this.originalResponse.lastModified; @@ -393,8 +333,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * last read or written to. * * @readonly - * @type {(Date | undefined)} - * @memberof BlobDownloadResponse */ public get lastAccessed(): Date | undefined { return this.originalResponse.lastAccessed; @@ -405,8 +343,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * to associate with a file storage object. * * @readonly - * @type {(Metadata | undefined)} - * @memberof BlobDownloadResponse */ public get metadata(): Metadata | undefined { return this.originalResponse.metadata; @@ -417,8 +353,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * that was made and can be used for troubleshooting the request. * * @readonly - * @type {(string | undefined)} - * @memberof BlobDownloadResponse */ public get requestId(): string | undefined { return this.originalResponse.requestId; @@ -429,8 +363,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * response with the same value. * * @readonly - * @type {(string | undefined)} - * @memberof BlobDownloadResponse */ public get clientRequestId(): string | undefined { return this.originalResponse.clientRequestId; @@ -441,8 +373,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * to execute the request. * * @readonly - * @type {(string | undefined)} - * @memberof BlobDownloadResponse */ public get version(): string | undefined { return this.originalResponse.version; @@ -452,8 +382,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * Indicates the versionId of the downloaded blob version. * * @readonly - * @type {(string | undefined)} - * @memberof BlobDownloadResponse */ public get versionId(): string | undefined { return this.originalResponse.versionId; @@ -463,8 +391,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * Indicates whether version of this blob is a current version. * * @readonly - * @type {(boolean | undefined)} - * @memberof BlobDownloadResponse */ public get isCurrentVersion(): boolean | undefined { return this.originalResponse.isCurrentVersion; @@ -475,8 +401,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * when the blob was encrypted with a customer-provided key. * * @readonly - * @type {(string | undefined)} - * @memberof BlobDownloadResponse */ public get encryptionKeySha256(): string | undefined { return this.originalResponse.encryptionKeySha256; @@ -487,9 +411,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * true, then the request returns a crc64 for the range, as long as the range size is less than * or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is * specified in the same request, it will fail with 400(Bad Request) - * - * @type {(Uint8Array | undefined)} - * @memberof BlobDownloadResponse */ public get contentCrc64(): Uint8Array | undefined { return this.originalResponse.contentCrc64; @@ -499,8 +420,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * Object Replication Policy Id of the destination blob. * * @readonly - * @type {(string| undefined)} - * @memberof BlobDownloadResponse */ public get objectReplicationDestinationPolicyId(): string | undefined { return this.originalResponse.objectReplicationDestinationPolicyId; @@ -510,8 +429,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * Parsed Object Replication Policy Id, Rule Id(s) and status of the source blob. * * @readonly - * @type {(ObjectReplicationPolicy[] | undefined)} - * @memberof BlobDownloadResponse */ public get objectReplicationSourceProperties(): ObjectReplicationPolicy[] | undefined { return this.originalResponse.objectReplicationSourceProperties; @@ -521,8 +438,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * If this blob has been sealed. * * @readonly - * @type {(boolean | undefined)} - * @memberof BlobDownloadResponse */ public get isSealed(): boolean | undefined { return this.originalResponse.isSealed; @@ -533,8 +448,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * Always undefined in node.js. * * @readonly - * @type {(Promise | undefined)} - * @memberof BlobDownloadResponse */ public get contentAsBlob(): Promise | undefined { return this.originalResponse.blobBody; @@ -547,8 +460,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * It will automatically retry when internal read stream unexpected ends. * * @readonly - * @type {(NodeJS.ReadableStream | undefined)} - * @memberof BlobDownloadResponse */ public get readableStreamBody(): NodeJS.ReadableStream | undefined { return isNode ? this.blobDownloadStream : undefined; @@ -556,9 +467,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { /** * The HTTP response. - * - * @type {HttpResponse} - * @memberof BlobDownloadResponse */ public get _response(): HttpResponse & { parsedHeaders: BlobDownloadHeaders; @@ -577,7 +485,6 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed { * @param offset - * @param count - * @param options - - * @memberof BlobDownloadResponse */ public constructor( originalResponse: BlobDownloadResponseParsed, diff --git a/sdk/storage/storage-blob/src/BlobLeaseClient.ts b/sdk/storage/storage-blob/src/BlobLeaseClient.ts index 0b2003e7401f..586c4a6defd5 100644 --- a/sdk/storage/storage-blob/src/BlobLeaseClient.ts +++ b/sdk/storage/storage-blob/src/BlobLeaseClient.ts @@ -81,33 +81,21 @@ export type LeaseOperationResponse = Lease & { /** * Configures lease operations. - * - * @export - * @interface LeaseOperationOptions */ export interface LeaseOperationOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof LeaseOperationOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when changing the lease. - * - * @type {ModifiedAccessConditions} - * @memberof LeaseOperationOptions */ conditions?: ModifiedAccessConditions; } /** * A client that manages leases for a {@link ContainerClient} or a {@link BlobClient}. - * - * @export - * @class BlobLeaseClient */ export class BlobLeaseClient { private _leaseId: string; @@ -119,8 +107,6 @@ export class BlobLeaseClient { * Gets the lease Id. * * @readonly - * @memberof BlobLeaseClient - * @type {string} */ public get leaseId(): string { return this._leaseId; @@ -130,8 +116,6 @@ export class BlobLeaseClient { * Gets the url. * * @readonly - * @memberof BlobLeaseClient - * @type {string} */ public get url(): string { return this._url; @@ -141,7 +125,6 @@ export class BlobLeaseClient { * Creates an instance of BlobLeaseClient. * @param client - The client to make the lease operation requests. * @param leaseId - Initial proposed lease id. - * @memberof BlobLeaseClient */ constructor(client: ContainerClient | BlobClient, leaseId?: string) { const clientContext = new StorageClientContext( @@ -175,7 +158,6 @@ export class BlobLeaseClient { * @param duration - Must be between 15 to 60 seconds, or infinite (-1) * @param options - option to configure lease management operations. * @returns Response data for acquire lease operation. - * @memberof BlobLeaseClient */ public async acquireLease( duration: number, @@ -228,7 +210,6 @@ export class BlobLeaseClient { * @param proposedLeaseId - the proposed new lease Id. * @param options - option to configure lease management operations. * @returns Response data for change lease operation. - * @memberof BlobLeaseClient */ public async changeLease( proposedLeaseId: string, @@ -282,7 +263,6 @@ export class BlobLeaseClient { * * @param options - option to configure lease management operations. * @returns Response data for release lease operation. - * @memberof BlobLeaseClient */ public async releaseLease(options: LeaseOperationOptions = {}): Promise { const { span, spanOptions } = createSpan( @@ -329,7 +309,6 @@ export class BlobLeaseClient { * * @param options - Optional option to configure lease management operations. * @returns Response data for renew lease operation. - * @memberof BlobLeaseClient */ public async renewLease(options: LeaseOperationOptions = {}): Promise { const { span, spanOptions } = createSpan("BlobLeaseClient-renewLease", options.tracingOptions); @@ -372,11 +351,9 @@ export class BlobLeaseClient { * and * @see https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob * - * @static * @param breakPeriod - Break period * @param options - Optional options to configure lease management operations. * @returns Response data for break lease operation. - * @memberof BlobLeaseClient */ public async breakLease( breakPeriod: number, diff --git a/sdk/storage/storage-blob/src/BlobQueryResponse.browser.ts b/sdk/storage/storage-blob/src/BlobQueryResponse.browser.ts index 1b6ed40888fd..9fe474532e13 100644 --- a/sdk/storage/storage-blob/src/BlobQueryResponse.browser.ts +++ b/sdk/storage/storage-blob/src/BlobQueryResponse.browser.ts @@ -21,10 +21,6 @@ import { BlobQuickQueryStreamOptions } from "./utils/BlobQuickQueryStream"; * * BlobQueryResponse implements BlobDownloadResponseModel interface, and in browser runtime it will * parse avor data returned by blob query. - * - * @export - * @class BlobQueryResponse - * @implements {BlobDownloadResponseModel} */ export class BlobQueryResponse implements BlobDownloadResponseModel { /** @@ -32,8 +28,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * requests for partial file content. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get acceptRanges(): string | undefined { return this.originalResponse.acceptRanges; @@ -44,8 +38,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * for the file. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get cacheControl(): string | undefined { return this.originalResponse.cacheControl; @@ -57,8 +49,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * response. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get contentDisposition(): string | undefined { return this.originalResponse.contentDisposition; @@ -69,8 +59,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * for the Content-Encoding request header. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get contentEncoding(): string | undefined { return this.originalResponse.contentEncoding; @@ -81,8 +69,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * for the Content-Language request header. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get contentLanguage(): string | undefined { return this.originalResponse.contentLanguage; @@ -93,8 +79,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * page blob. This header is not returned for block blobs or append blobs. * * @readonly - * @type {(number | undefined)} - * @memberof BlobQueryResponse */ public get blobSequenceNumber(): number | undefined { return this.originalResponse.blobSequenceNumber; @@ -105,8 +89,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * 'BlockBlob', 'PageBlob', 'AppendBlob'. * * @readonly - * @type {(BlobType | undefined)} - * @memberof BlobQueryResponse */ public get blobType(): BlobType | undefined { return this.originalResponse.blobType; @@ -117,8 +99,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * response body. * * @readonly - * @type {(number | undefined)} - * @memberof BlobQueryResponse */ public get contentLength(): number | undefined { return this.originalResponse.contentLength; @@ -135,8 +115,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * header. * * @readonly - * @type {(Uint8Array | undefined)} - * @memberof BlobQueryResponse */ public get contentMD5(): Uint8Array | undefined { return this.originalResponse.contentMD5; @@ -148,8 +126,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * header. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get contentRange(): string | undefined { return this.originalResponse.contentRange; @@ -160,8 +136,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * The default content type is 'application/octet-stream' * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get contentType(): string | undefined { return this.originalResponse.contentType; @@ -173,8 +147,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * can specify the time of a completed, aborted, or failed copy attempt. * * @readonly - * @type {(Date | undefined)} - * @memberof BlobQueryResponse */ public get copyCompletedOn(): Date | undefined { return undefined; @@ -185,8 +157,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * File operation where this file was the destination file. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get copyId(): string | undefined { return this.originalResponse.copyId; @@ -199,8 +169,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * Content-Length bytes copied. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get copyProgress(): string | undefined { return this.originalResponse.copyProgress; @@ -212,8 +180,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * was the destination file. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get copySource(): string | undefined { return this.originalResponse.copySource; @@ -225,8 +191,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * 'success', 'aborted', 'failed' * * @readonly - * @type {(CopyStatusType | undefined)} - * @memberof BlobQueryResponse */ public get copyStatus(): CopyStatusType | undefined { return this.originalResponse.copyStatus; @@ -238,8 +202,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * non-fatal copy operation failure. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get copyStatusDescription(): string | undefined { return this.originalResponse.copyStatusDescription; @@ -251,8 +213,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * values include: 'infinite', 'fixed'. * * @readonly - * @type {(LeaseDurationType | undefined)} - * @memberof BlobQueryResponse */ public get leaseDuration(): LeaseDurationType | undefined { return this.originalResponse.leaseDuration; @@ -263,8 +223,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * values include: 'available', 'leased', 'expired', 'breaking', 'broken'. * * @readonly - * @type {(LeaseStateType | undefined)} - * @memberof BlobQueryResponse */ public get leaseState(): LeaseStateType | undefined { return this.originalResponse.leaseState; @@ -275,8 +233,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * blob. Possible values include: 'locked', 'unlocked'. * * @readonly - * @type {(LeaseStatusType | undefined)} - * @memberof BlobQueryResponse */ public get leaseStatus(): LeaseStatusType | undefined { return this.originalResponse.leaseStatus; @@ -287,8 +243,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * indicates the time at which the response was initiated. * * @readonly - * @type {(Date | undefined)} - * @memberof BlobQueryResponse */ public get date(): Date | undefined { return this.originalResponse.date; @@ -299,8 +253,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * present in the blob. This header is returned only for append blobs. * * @readonly - * @type {(number | undefined)} - * @memberof BlobQueryResponse */ public get blobCommittedBlockCount(): number | undefined { return this.originalResponse.blobCommittedBlockCount; @@ -311,8 +263,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * perform operations conditionally, in quotes. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get etag(): string | undefined { return this.originalResponse.etag; @@ -322,8 +272,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * The error code. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get errorCode(): string | undefined { return this.originalResponse.errorCode; @@ -337,8 +285,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * are encrypted). * * @readonly - * @type {(boolean | undefined)} - * @memberof BlobQueryResponse */ public get isServerEncrypted(): boolean | undefined { return this.originalResponse.isServerEncrypted; @@ -352,8 +298,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * latter calculated from the requested range. * * @readonly - * @type {(Uint8Array | undefined)} - * @memberof BlobQueryResponse */ public get blobContentMD5(): Uint8Array | undefined { return this.originalResponse.blobContentMD5; @@ -365,8 +309,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * the last modified time. * * @readonly - * @type {(Date | undefined)} - * @memberof BlobQueryResponse */ public get lastModified(): Date | undefined { return this.originalResponse.lastModified; @@ -377,8 +319,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * to associate with a file storage object. * * @readonly - * @type {(Metadata | undefined)} - * @memberof BlobQueryResponse */ public get metadata(): Metadata | undefined { return this.originalResponse.metadata; @@ -389,8 +329,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * that was made and can be used for troubleshooting the request. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get requestId(): string | undefined { return this.originalResponse.requestId; @@ -401,8 +339,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * response with the same value. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get clientRequestId(): string | undefined { return this.originalResponse.clientRequestId; @@ -413,8 +349,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * to execute the request. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get version(): string | undefined { return this.originalResponse.version; @@ -425,8 +359,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * when the blob was encrypted with a customer-provided key. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get encryptionKeySha256(): string | undefined { return this.originalResponse.encryptionKeySha256; @@ -437,9 +369,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * true, then the request returns a crc64 for the range, as long as the range size is less than * or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is * specified in the same request, it will fail with 400(Bad Request) - * - * @type {(Uint8Array | undefined)} - * @memberof BlobQueryResponse */ public get contentCrc64(): Uint8Array | undefined { return this.originalResponse.contentCrc64; @@ -450,8 +379,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * Always undefined in node.js. * * @readonly - * @type {(Promise | undefined)} - * @memberof BlobQueryResponse */ public get blobBody(): Promise | undefined { throw Error(`Quick query in browser is not supported yet.`); @@ -462,8 +389,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * Always undefined in the browser. * * @readonly - * @type {(NodeJS.ReadableStream | undefined)} - * @memberof BlobQueryResponse */ public get readableStreamBody(): NodeJS.ReadableStream | undefined { return undefined; @@ -471,9 +396,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { /** * The HTTP response. - * - * @type {HttpResponse} - * @memberof BlobQueryResponse */ public get _response(): HttpResponse & { parsedHeaders: BlobDownloadHeaders; @@ -488,7 +410,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * * @param originalResponse - * @param options - - * @memberof BlobQueryResponse */ public constructor( originalResponse: BlobQueryResponseModel, diff --git a/sdk/storage/storage-blob/src/BlobQueryResponse.ts b/sdk/storage/storage-blob/src/BlobQueryResponse.ts index 174281f632ac..d4509323ce1b 100644 --- a/sdk/storage/storage-blob/src/BlobQueryResponse.ts +++ b/sdk/storage/storage-blob/src/BlobQueryResponse.ts @@ -21,10 +21,6 @@ import { BlobQuickQueryStream, BlobQuickQueryStreamOptions } from "./utils/BlobQ * * BlobQueryResponse implements BlobDownloadResponseModel interface, and in Node.js runtime it will * parse avor data returned by blob query. - * - * @export - * @class BlobQueryResponse - * @implements {BlobDownloadResponseModel} */ export class BlobQueryResponse implements BlobDownloadResponseModel { /** @@ -32,8 +28,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * requests for partial file content. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get acceptRanges(): string | undefined { return this.originalResponse.acceptRanges; @@ -44,8 +38,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * for the file. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get cacheControl(): string | undefined { return this.originalResponse.cacheControl; @@ -57,8 +49,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * response. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get contentDisposition(): string | undefined { return this.originalResponse.contentDisposition; @@ -69,8 +59,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * for the Content-Encoding request header. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get contentEncoding(): string | undefined { return this.originalResponse.contentEncoding; @@ -81,8 +69,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * for the Content-Language request header. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get contentLanguage(): string | undefined { return this.originalResponse.contentLanguage; @@ -93,8 +79,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * page blob. This header is not returned for block blobs or append blobs. * * @readonly - * @type {(number | undefined)} - * @memberof BlobQueryResponse */ public get blobSequenceNumber(): number | undefined { return this.originalResponse.blobSequenceNumber; @@ -105,8 +89,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * 'BlockBlob', 'PageBlob', 'AppendBlob'. * * @readonly - * @type {(BlobType | undefined)} - * @memberof BlobQueryResponse */ public get blobType(): BlobType | undefined { return this.originalResponse.blobType; @@ -117,8 +99,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * response body. * * @readonly - * @type {(number | undefined)} - * @memberof BlobQueryResponse */ public get contentLength(): number | undefined { return this.originalResponse.contentLength; @@ -135,8 +115,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * header. * * @readonly - * @type {(Uint8Array | undefined)} - * @memberof BlobQueryResponse */ public get contentMD5(): Uint8Array | undefined { return this.originalResponse.contentMD5; @@ -148,8 +126,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * header. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get contentRange(): string | undefined { return this.originalResponse.contentRange; @@ -160,8 +136,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * The default content type is 'application/octet-stream' * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get contentType(): string | undefined { return this.originalResponse.contentType; @@ -173,8 +147,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * can specify the time of a completed, aborted, or failed copy attempt. * * @readonly - * @type {(Date | undefined)} - * @memberof BlobQueryResponse */ public get copyCompletedOn(): Date | undefined { return undefined; @@ -185,8 +157,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * File operation where this file was the destination file. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get copyId(): string | undefined { return this.originalResponse.copyId; @@ -199,8 +169,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * Content-Length bytes copied. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get copyProgress(): string | undefined { return this.originalResponse.copyProgress; @@ -212,8 +180,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * was the destination file. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get copySource(): string | undefined { return this.originalResponse.copySource; @@ -225,8 +191,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * 'success', 'aborted', 'failed' * * @readonly - * @type {(CopyStatusType | undefined)} - * @memberof BlobQueryResponse */ public get copyStatus(): CopyStatusType | undefined { return this.originalResponse.copyStatus; @@ -238,8 +202,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * non-fatal copy operation failure. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get copyStatusDescription(): string | undefined { return this.originalResponse.copyStatusDescription; @@ -251,8 +213,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * values include: 'infinite', 'fixed'. * * @readonly - * @type {(LeaseDurationType | undefined)} - * @memberof BlobQueryResponse */ public get leaseDuration(): LeaseDurationType | undefined { return this.originalResponse.leaseDuration; @@ -263,8 +223,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * values include: 'available', 'leased', 'expired', 'breaking', 'broken'. * * @readonly - * @type {(LeaseStateType | undefined)} - * @memberof BlobQueryResponse */ public get leaseState(): LeaseStateType | undefined { return this.originalResponse.leaseState; @@ -275,8 +233,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * blob. Possible values include: 'locked', 'unlocked'. * * @readonly - * @type {(LeaseStatusType | undefined)} - * @memberof BlobQueryResponse */ public get leaseStatus(): LeaseStatusType | undefined { return this.originalResponse.leaseStatus; @@ -287,8 +243,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * indicates the time at which the response was initiated. * * @readonly - * @type {(Date | undefined)} - * @memberof BlobQueryResponse */ public get date(): Date | undefined { return this.originalResponse.date; @@ -299,8 +253,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * present in the blob. This header is returned only for append blobs. * * @readonly - * @type {(number | undefined)} - * @memberof BlobQueryResponse */ public get blobCommittedBlockCount(): number | undefined { return this.originalResponse.blobCommittedBlockCount; @@ -311,8 +263,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * perform operations conditionally, in quotes. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get etag(): string | undefined { return this.originalResponse.etag; @@ -322,8 +272,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * The error code. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get errorCode(): string | undefined { return this.originalResponse.errorCode; @@ -337,8 +285,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * are encrypted). * * @readonly - * @type {(boolean | undefined)} - * @memberof BlobQueryResponse */ public get isServerEncrypted(): boolean | undefined { return this.originalResponse.isServerEncrypted; @@ -352,8 +298,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * latter calculated from the requested range. * * @readonly - * @type {(Uint8Array | undefined)} - * @memberof BlobQueryResponse */ public get blobContentMD5(): Uint8Array | undefined { return this.originalResponse.blobContentMD5; @@ -365,8 +309,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * the last modified time. * * @readonly - * @type {(Date | undefined)} - * @memberof BlobQueryResponse */ public get lastModified(): Date | undefined { return this.originalResponse.lastModified; @@ -377,8 +319,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * to associate with a file storage object. * * @readonly - * @type {(Metadata | undefined)} - * @memberof BlobQueryResponse */ public get metadata(): Metadata | undefined { return this.originalResponse.metadata; @@ -389,8 +329,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * that was made and can be used for troubleshooting the request. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get requestId(): string | undefined { return this.originalResponse.requestId; @@ -401,8 +339,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * response with the same value. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get clientRequestId(): string | undefined { return this.originalResponse.clientRequestId; @@ -413,8 +349,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * to execute the request. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get version(): string | undefined { return this.originalResponse.version; @@ -425,8 +359,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * when the blob was encrypted with a customer-provided key. * * @readonly - * @type {(string | undefined)} - * @memberof BlobQueryResponse */ public get encryptionKeySha256(): string | undefined { return this.originalResponse.encryptionKeySha256; @@ -437,9 +369,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * true, then the request returns a crc64 for the range, as long as the range size is less than * or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is * specified in the same request, it will fail with 400(Bad Request) - * - * @type {(Uint8Array | undefined)} - * @memberof BlobQueryResponse */ public get contentCrc64(): Uint8Array | undefined { return this.originalResponse.contentCrc64; @@ -450,8 +379,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * Always undefined in node.js. * * @readonly - * @type {(Promise | undefined)} - * @memberof BlobQueryResponse */ public get blobBody(): Promise | undefined { return undefined; @@ -464,8 +391,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * It will parse avor data returned by blob query. * * @readonly - * @type {(NodeJS.ReadableStream | undefined)} - * @memberof BlobQueryResponse */ public get readableStreamBody(): NodeJS.ReadableStream | undefined { return isNode ? this.blobDownloadStream : undefined; @@ -473,9 +398,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { /** * The HTTP response. - * - * @type {HttpResponse} - * @memberof BlobQueryResponse */ public get _response(): HttpResponse & { parsedHeaders: BlobDownloadHeaders; @@ -491,7 +413,6 @@ export class BlobQueryResponse implements BlobDownloadResponseModel { * * @param originalResponse - * @param options - - * @memberof BlobQueryResponse */ public constructor( originalResponse: BlobQueryResponseModel, diff --git a/sdk/storage/storage-blob/src/BlobServiceClient.ts b/sdk/storage/storage-blob/src/BlobServiceClient.ts index 3470b1056b18..cfce2b6622b2 100644 --- a/sdk/storage/storage-blob/src/BlobServiceClient.ts +++ b/sdk/storage/storage-blob/src/BlobServiceClient.ts @@ -58,101 +58,66 @@ import { AccountSASServices } from "./sas/AccountSASServices"; /** * Options to configure the {@link BlobServiceClient.getProperties} operation. - * - * @export - * @interface ServiceGetPropertiesOptions */ export interface ServiceGetPropertiesOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ServiceGetPropertiesOptions */ abortSignal?: AbortSignalLike; } /** * Options to configure the {@link BlobServiceClient.setProperties} operation. - * - * @export - * @interface ServiceSetPropertiesOptions */ export interface ServiceSetPropertiesOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ServiceSetPropertiesOptions */ abortSignal?: AbortSignalLike; } /** * Options to configure the {@link BlobServiceClient.getAccountInfo} operation. - * - * @export - * @interface ServiceGetAccountInfoOptions */ export interface ServiceGetAccountInfoOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ServiceGetAccountInfoOptions */ abortSignal?: AbortSignalLike; } /** * Options to configure the {@link BlobServiceClient.getStatistics} operation. - * - * @export - * @interface ServiceGetStatisticsOptions */ export interface ServiceGetStatisticsOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ServiceGetStatisticsOptions */ abortSignal?: AbortSignalLike; } /** * Options to configure the Service - Get User Delegation Key. - * - * @export - * @interface ServiceGetUserDelegationKeyOptions */ export interface ServiceGetUserDelegationKeyOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ServiceGetStatisticsOptions */ abortSignal?: AbortSignalLike; } /** * Options to configure the {@link BlobServiceClient.listContainerSegment} operation. - * - * @interface ServiceListContainersSegmentOptions */ interface ServiceListContainersSegmentOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ServiceListContainersSegmentOptions */ abortSignal?: AbortSignalLike; /** @@ -180,17 +145,11 @@ interface ServiceListContainersSegmentOptions extends CommonOptions { /** * Options to configure the {@link BlobServiceClient.listContainers} operation. - * - * @export - * @interface ServiceListContainersOptions */ export interface ServiceListContainersOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ServiceListContainersOptions */ abortSignal?: AbortSignalLike; /** @@ -206,25 +165,17 @@ export interface ServiceListContainersOptions extends CommonOptions { /** * Specifies whether soft deleted containers should be included in the response. - * - * @type {boolean} - * @memberof ServiceListContainersOptions */ includeDeleted?: boolean; } /** * Options to configure the {@link BlobServiceClient.findBlobsByTagsSegment} operation. - * - * @interface ServiceFindBlobsByTagsSegmentOptions */ interface ServiceFindBlobsByTagsSegmentOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ServiceFindBlobsByTagsSegmentOptions */ abortSignal?: AbortSignalLike; /** @@ -235,25 +186,17 @@ interface ServiceFindBlobsByTagsSegmentOptions extends CommonOptions { * service will return a continuation token for retrieving the remainder of * the results. For this reason, it is possible that the service will return * fewer results than specified by maxPageSize, or than the default of 5000. - * @type {number} - * @memberof ServiceFindBlobsByTagsSegmentOptions */ maxPageSize?: number; } /** * Options to configure the {@link BlobServiceClient.findBlobsByTags} operation. - * - * @export - * @interface ServiceFindBlobByTagsOptions */ export interface ServiceFindBlobByTagsOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ServiceListContainersOptions */ abortSignal?: AbortSignalLike; } @@ -264,25 +207,16 @@ export interface ServiceFindBlobByTagsOptions extends CommonOptions { export interface FilterBlobItem { /** * Blob Name. - * - * @type {string} - * @memberof FilterBlobItem */ name: string; /** * Container Name. - * - * @type {string} - * @memberof FilterBlobItem */ containerName: string; /** * Blob Tags. - * - * @type {Tags} - * @memberof FilterBlobItem */ tags?: Tags; @@ -290,8 +224,6 @@ export interface FilterBlobItem { * Tag value. * * @deprecated The service no longer returns this value. Use {@link tags} to fetch all matching Blob Tags. - * @type {string} - * @memberof FilterBlobItem */ tagValue: string; } @@ -338,51 +270,30 @@ export type ServiceFindBlobsByTagsSegmentResponse = FilterBlobSegment & export interface UserDelegationKey { /** * The Azure Active Directory object ID in GUID format. - * - * @type {string} - * @memberof UserDelegationKey */ signedObjectId: string; /** * The Azure Active Directory tenant ID in GUID format. - * - * @type {string} - * @memberof UserDelegationKey */ signedTenantId: string; /** * The date-time the key is active. - * - * @type {Date} - * @memberof UserDelegationKey */ signedStartsOn: Date; /** * The date-time the key expires. - * - * @type {Date} - * @memberof UserDelegationKey */ signedExpiresOn: Date; /** * Abbreviation of the Azure Storage service that accepts the key. - * - * @type {string} - * @memberof UserDelegationKey */ signedService: string; /** * The service version that created the key. - * - * @type {string} - * @memberof UserDelegationKey */ signedVersion: string; /** * The key as a base64 string. - * - * @type {string} - * @memberof UserDelegationKey */ value: string; } @@ -415,90 +326,57 @@ export declare type ServiceGetUserDelegationKeyResponse = UserDelegationKey & /** * Options to configure {@link BlobServiceClient.undeleteContainer} operation. - * - * @export - * @interface ServiceUndeleteContainerOptions */ export interface ServiceUndeleteContainerOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ServiceUndeleteContainerOptions */ abortSignal?: AbortSignalLike; /** * Optional. Specifies the new name of the restored container. * Will use its original name if this is not specified. - * - * @type {string} - * @memberof ServiceUndeleteContainerOptions */ destinationContainerName?: string; } /** * Options to configure {@link BlobServiceClient.renameContainer} operation. - * - * @export - * @interface ServiceRenameContainerOptions */ export interface ServiceRenameContainerOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ServiceRenameContainerOptions */ abortSignal?: AbortSignalLike; /** * Condition to meet for the source container. - * - * @type {LeaseAccessConditions} - * @memberof ServiceRenameContainerOptions */ sourceCondition?: LeaseAccessConditions; } /** * Options to configure {@link BlobServiceClient.generateAccountSasUrl} operation. - * - * @export - * @interface ServiceGenerateAccountSasUrlOptions */ export interface ServiceGenerateAccountSasUrlOptions { /** * 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 ServiceGenerateAccountSasUrlOptions */ version?: string; /** * Optional. SAS protocols allowed. - * - * @type {SASProtocol} - * @memberof ServiceGenerateAccountSasUrlOptions */ protocol?: SASProtocol; /** * Optional. When the SAS will take effect. - * - * @type {Date} - * @memberof ServiceGenerateAccountSasUrlOptions */ startsOn?: Date; /** * Optional. IP range allowed. - * - * @type {SasIPRange} - * @memberof ServiceGenerateAccountSasUrlOptions */ ipRange?: SasIPRange; } @@ -506,17 +384,10 @@ export interface ServiceGenerateAccountSasUrlOptions { /** * A BlobServiceClient represents a Client to the Azure Storage Blob service allowing you * to manipulate blob containers. - * - * @export - * @class BlobServiceClient */ export class BlobServiceClient extends StorageClient { /** * serviceContext provided by protocol layer. - * - * @private - * @type {Service} - * @memberof BlobServiceClient */ private serviceContext: Service; @@ -531,7 +402,6 @@ export class BlobServiceClient extends StorageClient { * SAS connection string example - * `BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString` * @param options - Optional. Options to configure the HTTP pipeline. - * @memberof BlobServiceClient */ public static fromConnectionString(connectionString: string, options?: StoragePipelineOptions) { options = options || {}; @@ -564,9 +434,8 @@ export class BlobServiceClient extends StorageClient { * @param url - A Client string pointing to Azure Storage blob service, such as * "https://myaccount.blob.core.windows.net". You can append a SAS * if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString". - * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. + * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. * @param options - Optional. Options to configure the HTTP pipeline. - * @memberof BlobServiceClient * * Example using DefaultAzureCredential from `@azure/identity`: * @@ -606,7 +475,6 @@ export class BlobServiceClient extends StorageClient { * if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString". * @param pipeline - Call newPipeline() to create a default * pipeline, or provide a customized pipeline. - * @memberof BlobServiceClient */ constructor(url: string, pipeline: Pipeline); constructor( @@ -640,7 +508,6 @@ export class BlobServiceClient extends StorageClient { * * @param containerName - A container name * @returns A new ContainerClient object for the given container name. - * @memberof BlobServiceClient * * Example usage: * @@ -661,7 +528,6 @@ export class BlobServiceClient extends StorageClient { * @param containerName - Name of the container to create. * @param options - Options to configure Container Create operation. * @returns Container creation response and the corresponding container client. - * @memberof BlobServiceClient */ public async createContainer( containerName: string, @@ -701,7 +567,6 @@ export class BlobServiceClient extends StorageClient { * @param containerName - Name of the container to delete. * @param options - Options to configure Container Delete operation. * @returns Container deletion response. - * @memberof BlobServiceClient */ public async deleteContainer( containerName: string, @@ -736,7 +601,6 @@ export class BlobServiceClient extends StorageClient { * @param deletedContainerVersion - Version of the previously deleted container, used to uniquely identify the deleted container. * @param options - Options to configure Container Restore operation. * @returns Container deletion response. - * @memberof BlobServiceClient */ public async undeleteContainer( deletedContainerName: string, @@ -780,7 +644,6 @@ export class BlobServiceClient extends StorageClient { * @param sourceContainerName - The name of the source container. * @param destinationContainerName - The new name of the container. * @param options - Options to configure Container Rename operation. - * @memberof BlobServiceClient */ // @ts-ignore Need to hide this interface for now. Make it public and turn on the live tests for it when the service is ready. private async renameContainer( @@ -823,7 +686,6 @@ export class BlobServiceClient extends StorageClient { * * @param options - Options to the Service Get Properties operation. * @returns Response data for the Service Get Properties operation. - * @memberof BlobServiceClient */ public async getProperties( options: ServiceGetPropertiesOptions = {} @@ -851,12 +713,11 @@ export class BlobServiceClient extends StorageClient { /** * Sets properties for a storage account’s Blob service endpoint, including properties * for Storage Analytics, CORS (Cross-Origin Resource Sharing) rules and soft delete settings. - * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties} + * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties * * @param properties - * @param options - Options to the Service Set Properties operation. * @returns Response data for the Service Set Properties operation. - * @memberof BlobServiceClient */ public async setProperties( properties: BlobServiceProperties, @@ -886,11 +747,10 @@ export class BlobServiceClient extends StorageClient { * Retrieves statistics related to replication for the Blob service. It is only * available on the secondary location endpoint when read-access geo-redundant * replication is enabled for the storage account. - * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats} + * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats * * @param options - Options to the Service Get Statistics operation. * @returns Response data for the Service Get Statistics operation. - * @memberof BlobServiceClient */ public async getStatistics( options: ServiceGetStatisticsOptions = {} @@ -924,7 +784,6 @@ export class BlobServiceClient extends StorageClient { * * @param options - Options to the Service Get Account Info operation. * @returns Response data for the Service Get Account Info operation. - * @memberof BlobServiceClient */ public async getAccountInfo( options: ServiceGetAccountInfoOptions = {} @@ -962,7 +821,6 @@ export class BlobServiceClient extends StorageClient { * items. The marker value is opaque to the client. * @param options - Options to the Service List Container Segment operation. * @returns Response data for the Service List Container Segment operation. - * @memberof BlobServiceClient */ private async listContainersSegment( marker?: string, @@ -997,7 +855,6 @@ export class BlobServiceClient extends StorageClient { * match a given search expression. Filter blobs searches across all containers within a * storage account but can be scoped within the expression to a single container. * - * @private * @param tagFilterSqlExpression - The where parameter enables the caller to query blobs whose tags match a given expression. * The given expression must evaluate to true for a blob to be returned in the results. * The[OData - ABNF] filter syntax rule defines the formal grammar for the value of the where query parameter; @@ -1010,8 +867,6 @@ export class BlobServiceClient extends StorageClient { * the marker parameter in a subsequent call to request the next page of list * items. The marker value is opaque to the client. * @param options - Options to find blobs by tags. - * - * @memberof BlobServiceClient */ private async findBlobsByTagsSegment( tagFilterSqlExpression: string, @@ -1058,7 +913,6 @@ export class BlobServiceClient extends StorageClient { /** * Returns an AsyncIterableIterator for ServiceFindBlobsByTagsSegmentResponse. * - * @private * @param tagFilterSqlExpression - The where parameter enables the caller to query blobs whose tags match a given expression. * The given expression must evaluate to true for a blob to be returned in the results. * The[OData - ABNF] filter syntax rule defines the formal grammar for the value of the where query parameter; @@ -1071,8 +925,6 @@ export class BlobServiceClient extends StorageClient { * the marker parameter in a subsequent call to request the next page of list * items. The marker value is opaque to the client. * @param options - Options to find blobs by tags. - * - * @memberof BlobServiceClient */ private async *findBlobsByTagsSegments( tagFilterSqlExpression: string, @@ -1093,14 +945,11 @@ export class BlobServiceClient extends StorageClient { /** * Returns an AsyncIterableIterator for blobs. * - * @private * @param tagFilterSqlExpression - The where parameter enables the caller to query blobs whose tags match a given expression. * The given expression must evaluate to true for a blob to be returned in the results. * The[OData - ABNF] filter syntax rule defines the formal grammar for the value of the where query parameter; * however, only a subset of the OData filter syntax is supported in the Blob service. * @param options - Options to findBlobsByTagsItems. - * - * @memberof BlobServiceClient */ private async *findBlobsByTagsItems( tagFilterSqlExpression: string, @@ -1194,8 +1043,6 @@ export class BlobServiceClient extends StorageClient { * The[OData - ABNF] filter syntax rule defines the formal grammar for the value of the where query parameter; * however, only a subset of the OData filter syntax is supported in the Blob service. * @param options - Options to find blobs by tags. - * - * @memberof BlobServiceClient */ public findBlobsByTags( tagFilterSqlExpression: string, @@ -1209,19 +1056,19 @@ export class BlobServiceClient extends StorageClient { const iter = this.findBlobsByTagsItems(tagFilterSqlExpression, listSegmentOptions); return { /** - * @member {Promise} [next] The next method, part of the iteration protocol + * The next method, part of the iteration protocol */ next() { return iter.next(); }, /** - * @member {Symbol} [asyncIterator] The connection to the async iterator, part of the iteration protocol + * The connection to the async iterator, part of the iteration protocol */ [Symbol.asyncIterator]() { return this; }, /** - * @member {Function} [byPage] Return an AsyncIterableIterator that works a page at a time + * Return an AsyncIterableIterator that works a page at a time */ byPage: (settings: PageSettings = {}) => { return this.findBlobsByTagsSegments(tagFilterSqlExpression, settings.continuationToken, { @@ -1235,7 +1082,6 @@ export class BlobServiceClient extends StorageClient { /** * Returns an AsyncIterableIterator for ServiceListContainersSegmentResponses * - * @private * @param marker - A string value that identifies the portion of * the list of containers to be returned with the next listing operation. The * operation returns the continuationToken value within the response body if the @@ -1244,8 +1090,6 @@ export class BlobServiceClient extends StorageClient { * the marker parameter in a subsequent call to request the next page of list * items. The marker value is opaque to the client. * @param options - Options to list containers operation. - * - * @memberof BlobServiceClient */ private async *listSegments( marker?: string, @@ -1266,10 +1110,7 @@ export class BlobServiceClient extends StorageClient { /** * Returns an AsyncIterableIterator for Container Items * - * @private * @param options - Options to list containers operation. - * - * @memberof BlobServiceClient */ private async *listItems( options: ServiceListContainersSegmentOptions = {} @@ -1353,7 +1194,6 @@ export class BlobServiceClient extends StorageClient { * * @param options - Options to list containers. * @returns An asyncIterableIterator that supports paging. - * @memberof BlobServiceClient */ public listContainers( options: ServiceListContainersOptions = {} @@ -1379,19 +1219,19 @@ export class BlobServiceClient extends StorageClient { const iter = this.listItems(listSegmentOptions); return { /** - * @member {Promise} [next] The next method, part of the iteration protocol + * The next method, part of the iteration protocol */ next() { return iter.next(); }, /** - * @member {Symbol} [asyncIterator] The connection to the async iterator, part of the iteration protocol + * The connection to the async iterator, part of the iteration protocol */ [Symbol.asyncIterator]() { return this; }, /** - * @member {Function} [byPage] Return an AsyncIterableIterator that works a page at a time + * Return an AsyncIterableIterator that works a page at a time */ byPage: (settings: PageSettings = {}) => { return this.listSegments(settings.continuationToken, { @@ -1412,8 +1252,6 @@ export class BlobServiceClient extends StorageClient { * * @param startsOn - The start time for the user delegation SAS. Must be within 7 days of the current time * @param expiresOn - The end time for the user delegation SAS. Must be within 7 days of the current time - * - * @memberof BlobServiceClient */ public async getUserDelegationKey( startsOn: Date, @@ -1474,7 +1312,6 @@ export class BlobServiceClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch * * @returns A new BlobBatchClient object for this service. - * @memberof BlobServiceClient */ public getBlobBatchClient(): BlobBatchClient { return new BlobBatchClient(this.url, this.pipeline); @@ -1493,7 +1330,6 @@ export class BlobServiceClient extends StorageClient { * @param resourceTypes - Specifies the resource types associated with the shared access signature. * @param options - Optional parameters. * @returns An account SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token. - * @memberof BlobServiceClient */ public generateAccountSasUrl( expiresOn?: Date, diff --git a/sdk/storage/storage-blob/src/Clients.ts b/sdk/storage/storage-blob/src/Clients.ts index 952e0dca7551..2db09f8bf579 100644 --- a/sdk/storage/storage-blob/src/Clients.ts +++ b/sdk/storage/storage-blob/src/Clients.ts @@ -134,24 +134,16 @@ import { BlobLeaseClient } from "./BlobLeaseClient"; /** * Options to configure the {@link BlobClient.beginCopyFromURL} operation. - * - * @export - * @interface BlobBeginCopyFromURLOptions */ export interface BlobBeginCopyFromURLOptions extends BlobStartCopyFromURLOptions { /** * The amount of time in milliseconds the poller should wait between * calls to the service to determine the status of the Blob copy. * Defaults to 15 seconds. - * - * @type {number} - * @memberof BlobBeginCopyFromURLOptions */ intervalInMs?: number; /** * Callback to receive the state of the copy progress. - * - * @memberof BlobBeginCopyFromURLOptions */ onProgress?: (state: BlobBeginCopyFromUrlPollState) => void; /** @@ -161,40 +153,26 @@ export interface BlobBeginCopyFromURLOptions extends BlobStartCopyFromURLOptions * * To get serialized poller state, call `poller.toString()` on an existing * poller. - * - * @memberof BlobBeginCopyFromURLOptions */ resumeFrom?: string; } /** * Contains response data for the {@link BlobClient.beginCopyFromURL} operation. - * - * @export - * @interface BlobBeginCopyFromURLResponse */ export interface BlobBeginCopyFromURLResponse extends BlobStartCopyFromURLResponse {} /** * Options to configure the {@link BlobClient.download} operation. - * - * @export - * @interface BlobDownloadOptions */ export interface BlobDownloadOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlobDownloadOptions */ abortSignal?: AbortSignalLike; /** * An opaque DateTime string value that, when present, specifies the blob snapshot to retrieve. - * - * @type {string} - * @memberof BlobDownloadOptions */ snapshot?: string; /** @@ -202,9 +180,6 @@ export interface BlobDownloadOptions extends CommonOptions { * as long as the range is less than or equal to 4 MB in size. * * rangeGetContentCrc64 and rangeGetContentMD5 cannot be set at same time. - * - * @type {boolean} - * @memberof BlobDownloadOptions */ rangeGetContentMD5?: boolean; /** @@ -212,23 +187,14 @@ export interface BlobDownloadOptions extends CommonOptions { * as long as the range is less than or equal to 4 MB in size. * * rangeGetContentCrc64 and rangeGetContentMD5 cannot be set at same time. - * - * @type {boolean} - * @memberof BlobDownloadOptions */ rangeGetContentCrc64?: boolean; /** * Conditions to meet when downloading blobs. - * - * @type {BlobRequestConditions} - * @memberof BlobDownloadOptions */ conditions?: BlobRequestConditions; /** * Call back to receive events on the progress of download operation. - * - * @type {(progress: TransferProgressEvent) => void} - * @memberof BlobDownloadOptions */ onProgress?: (progress: TransferProgressEvent) => void; @@ -243,204 +209,126 @@ export interface BlobDownloadOptions extends CommonOptions { * from the broken point, until the requested range has been successfully downloaded or maxRetryRequests is reached. * * Default value is 5, please set a larger value when loading large files in poor network. - * - * @type {number} - * @memberof BlobDownloadOptions */ maxRetryRequests?: number; /** * Customer Provided Key Info. - * - * @type {CpkInfo} - * @memberof BlobDownloadOptions */ customerProvidedKey?: CpkInfo; } /** * Options to configure the {@link BlobClient.exists} operation. - * - * @export - * @interface BlobExistsOptions */ export interface BlobExistsOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlobExistsOptions */ abortSignal?: AbortSignalLike; /** * Customer Provided Key Info. - * - * @type {CpkInfo} - * @memberof BlobExistsOptions */ customerProvidedKey?: CpkInfo; /** * Conditions to meet. - * - * @type {BlobRequestConditions} - * @memberof BlobExistsOptions */ conditions?: BlobRequestConditions; } /** * Options to configure the {@link BlobClient.getProperties} operation. - * - * @export - * @interface BlobGetPropertiesOptions */ export interface BlobGetPropertiesOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlobGetPropertiesOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when getting blob properties. - * - * @type {BlobRequestConditions} - * @memberof BlobGetPropertiesOptions */ conditions?: BlobRequestConditions; /** * Customer Provided Key Info. - * - * @type {CpkInfo} - * @memberof BlobGetPropertiesOptions */ customerProvidedKey?: CpkInfo; } /** * Options to configure the {@link BlobClient.delete} operation. - * - * @export - * @interface BlobDeleteOptions */ export interface BlobDeleteOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlobDeleteOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when deleting blobs. - * - * @type {BlobRequestConditions} - * @memberof BlobDeleteOptions */ conditions?: BlobRequestConditions; /** * Specifies options to delete blobs that have associated snapshots. * - `include`: Delete the base blob and all of its snapshots. * - `only`: Delete only the blob's snapshots and not the blob itself. - * - * @type {DeleteSnapshotsOptionType} - * @memberof BlobDeleteOptions */ deleteSnapshots?: DeleteSnapshotsOptionType; /** * Customer Provided Key Info. - * - * @type {CpkInfo} - * @memberof BlobDeleteOptions */ customerProvidedKey?: CpkInfo; } /** * Options to configure the {@link BlobClient.undelete} operation. - * - * @export - * @interface BlobUndeleteOptions */ export interface BlobUndeleteOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlobUndeleteOptions */ abortSignal?: AbortSignalLike; /** * Customer Provided Key Info. - * - * @type {CpkInfo} - * @memberof BlobUndeleteOptions */ customerProvidedKey?: CpkInfo; } /** * Options to configure the {@link BlobClient.setHTTPHeaders} operation. - * - * @export - * @interface BlobSetHTTPHeadersOptions */ export interface BlobSetHTTPHeadersOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlobSetHTTPHeadersOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when setting blob HTTP headers. - * - * @type {BlobRequestConditions} - * @memberof BlobSetHTTPHeadersOptions */ conditions?: BlobRequestConditions; /** * Customer Provided Key Info. - * - * @type {CpkInfo} - * @memberof BlobSetHTTPHeadersOptions */ customerProvidedKey?: CpkInfo; } /** * Options to configure the {@link BlobClient.setMetadata} operation. - * - * @export - * @interface BlobSetMetadataOptions */ export interface BlobSetMetadataOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlobSetMetadataOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when setting blob metadata. - * - * @type {BlobRequestConditions} - * @memberof BlobSetMetadataOptions */ conditions?: BlobRequestConditions; /** * Customer Provided Key Info. - * - * @type {CpkInfo} - * @memberof BlobSetMetadataOptions */ customerProvidedKey?: CpkInfo; /** @@ -448,57 +336,36 @@ export interface BlobSetMetadataOptions extends CommonOptions { * encrypt the data provided in the request. If not specified, encryption is performed with the * default account encryption scope. For more information, see Encryption at Rest for Azure * Storage Services. - * - * @type {string} - * @memberof BlobSetMetadataOptions */ encryptionScope?: string; } /** * Options to configure the {@link BlobClient.setTags} operation. - * - * @export - * @interface BlobSetTagsOptions */ export interface BlobSetTagsOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlobSetTagsOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet for the blob to perform this operation. - * - * @type {TagConditions & LeaseAccessConditions} - * @memberof BlobSetTagsOptions */ conditions?: TagConditions & LeaseAccessConditions; } /** * Options to configure the {@link BlobClient.getTags} operation. - * - * @export - * @interface BlobGetTagsOptions */ export interface BlobGetTagsOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlobGetTagsOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet for the blob to perform this operation. - * - * @type {TagConditions & LeaseAccessConditions} - * @memberof BlobGetTagsOptions */ conditions?: TagConditions & LeaseAccessConditions; } @@ -530,158 +397,98 @@ export type BlobGetTagsResponse = { tags: Tags } & BlobGetTagsHeaders & { /** * Options to configure Blob - Acquire Lease operation. - * - * @export - * @interface BlobAcquireLeaseOptions */ export interface BlobAcquireLeaseOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlobAcquireLeaseOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when acquiring the lease of a blob. - * - * @type {ModifiedAccessConditions} - * @memberof BlobAcquireLeaseOptions */ conditions?: ModifiedAccessConditions; } /** * Options to configure Blob - Release Lease operation. - * - * @export - * @interface BlobReleaseLeaseOptions */ export interface BlobReleaseLeaseOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlobReleaseLeaseOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when releasing the lease of a blob. - * - * @type {ModifiedAccessConditions} - * @memberof BlobReleaseLeaseOptions */ conditions?: ModifiedAccessConditions; } /** * Options to configure Blob - Renew Lease operation. - * - * @export - * @interface BlobRenewLeaseOptions */ export interface BlobRenewLeaseOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlobRenewLeaseOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when renewing the lease of a blob. - * - * @type {ModifiedAccessConditions} - * @memberof BlobRenewLeaseOptions */ conditions?: ModifiedAccessConditions; } /** * Options to configure Blob - Change Lease operation. - * - * @export - * @interface BlobChangeLeaseOptions */ export interface BlobChangeLeaseOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlobChangeLeaseOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when changing the lease of a blob. - * - * @type {ModifiedAccessConditions} - * @memberof BlobChangeLeaseOptions */ conditions?: ModifiedAccessConditions; } /** * Options to configure Blob - Break Lease operation. - * - * @export - * @interface BlobBreakLeaseOptions */ export interface BlobBreakLeaseOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlobBreakLeaseOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when breaking the lease of a blob. - * - * @type {ModifiedAccessConditions} - * @memberof BlobBreakLeaseOptions */ conditions?: ModifiedAccessConditions; } /** * Options to configure the {@link BlobClient.createSnapshot} operation. - * - * @export - * @interface BlobCreateSnapshotOptions */ export interface BlobCreateSnapshotOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlobCreateSnapshotOptions */ abortSignal?: AbortSignalLike; /** * A collection of key-value string pair to associate with the snapshot. - * - * @type {Metadata} - * @memberof BlobCreateSnapshotOptions */ metadata?: Metadata; /** * Conditions to meet when creating blob snapshots. - * - * @type {BlobRequestConditions} - * @memberof BlobCreateSnapshotOptions */ conditions?: BlobRequestConditions; /** * Customer Provided Key Info. - * - * @type {CpkInfo} - * @memberof BlobCreateSnapshotOptions */ customerProvidedKey?: CpkInfo; /** @@ -689,214 +496,133 @@ export interface BlobCreateSnapshotOptions extends CommonOptions { * encrypt the data provided in the request. If not specified, encryption is performed with the * default account encryption scope. For more information, see Encryption at Rest for Azure * Storage Services. - * - * @type {string} - * @memberof BlobCreateSnapshotOptions */ encryptionScope?: string; } /** * Options to configure the {@link BlobClient.beginCopyFromURL} operation. - * - * @export - * @interface BlobStartCopyFromURLOptions */ export interface BlobStartCopyFromURLOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlobStartCopyFromURLOptions */ abortSignal?: AbortSignalLike; /** * A collection of key-value string pair to associate with the blob that are being copied. - * - * @type {Metadata} - * @memberof BlobStartCopyFromURLOptions */ metadata?: Metadata; /** * Conditions to meet for the destination blob when copying from a URL to the blob. - * - * @type {BlobRequestConditions} - * @memberof BlobStartCopyFromURLOptions */ conditions?: BlobRequestConditions; /** * Conditions to meet for the source Azure Blob/File when copying from a URL to the blob. - * - * @type {ModifiedAccessConditions} - * @memberof BlobStartCopyFromURLOptions */ sourceConditions?: ModifiedAccessConditions; /** * Access tier. * More Details - https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers - * - * @type {BlockBlobTier | PremiumPageBlobTier | string} - * @memberof BlobStartCopyFromURLOptions */ tier?: BlockBlobTier | PremiumPageBlobTier | string; /** * Rehydrate Priority - possible values include 'High', 'Standard'. * More Details - https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-rehydration#rehydrate-an-archived-blob-to-an-online-tier - * - * @type {RehydratePriority} - * @memberof BlobStartCopyFromURLOptions */ rehydratePriority?: RehydratePriority; /** * Blob tags. - * - * @type {Tags} - * @memberof BlobStartCopyFromURLOptions */ tags?: Tags; /** * Overrides the sealed state of the destination blob. Default true. - * - * @type {boolean} - * @memberof BlobStartCopyFromURLOptions */ sealBlob?: boolean; } /** * Options to configure the {@link BlobClient.abortCopyFromURL} operation. - * - * @export - * @interface BlobAbortCopyFromURLOptions */ export interface BlobAbortCopyFromURLOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlobAbortCopyFromURLOptions */ abortSignal?: AbortSignalLike; /** * If specified, contains the lease id that must be matched and lease with this id * must be active in order for the operation to succeed. - * - * @type {LeaseAccessConditions} - * @memberof BlobAbortCopyFromURLOptions */ conditions?: LeaseAccessConditions; } /** * Options to configure the {@link BlobClient.syncCopyFromURL} operation. - * - * @export - * @interface BlobSyncCopyFromURLOptions */ export interface BlobSyncCopyFromURLOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlobSyncCopyFromURLOptions */ abortSignal?: AbortSignalLike; /** * A collection of key-value string pair to associate with the snapshot. - * - * @type {Metadata} - * @memberof BlobSyncCopyFromURLOptions */ metadata?: Metadata; /** * Conditions to meet for the destination blob when copying from a URL to the blob. - * - * @type {BlobRequestConditions} - * @memberof BlobSyncCopyFromURLOptions */ conditions?: BlobRequestConditions; /** * Conditions to meet for the source Azure Blob/File when copying from a URL to the blob. - * - * @type {MatchConditions & ModificationConditions} - * @memberof BlobSyncCopyFromURLOptions */ sourceConditions?: MatchConditions & ModificationConditions; /** * Specify the md5 calculated for the range of bytes that must be read from the copy source. - * - * @type {Uint8Array} - * @memberof BlobSyncCopyFromURLOptions */ sourceContentMD5?: Uint8Array; /** * Blob tags. - * - * @type {Tags} - * @memberof BlobSyncCopyFromURLOptions */ tags?: Tags; } /** * Options to configure the {@link BlobClient.setAccessTier} operation. - * - * @export - * @interface BlobSetTierOptions */ export interface BlobSetTierOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlobSetTierOptions */ abortSignal?: AbortSignalLike; /** * If specified, contains the lease id that must be matched and lease with this id * must be active in order for the operation to succeed. - * - * @type {LeaseAccessConditions & TagConditions} - * @memberof BlobSetTierOptions */ conditions?: LeaseAccessConditions & TagConditions; /** * Rehydrate Priority - possible values include 'High', 'Standard'. * More Details - https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-rehydration#rehydrate-an-archived-blob-to-an-online-tier - * - * @type {RehydratePriority} - * @memberof BlobSetTierOptions */ rehydratePriority?: RehydratePriority; } /** * Option interface for the {@link BlobClient.downloadToBuffer} operation. - * - * @export - * @interface BlobDownloadToBufferOptions */ export interface BlobDownloadToBufferOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlobDownloadToBufferOptions */ abortSignal?: AbortSignalLike; /** * 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 BlobDownloadToBufferOptions + * Must be greater than or equal to 0. + * If set to 0 or undefined, blockSize will automatically calculated according to the blob size. */ blockSize?: number; @@ -912,129 +638,81 @@ export interface BlobDownloadToBufferOptions extends CommonOptions { * maxRetryRequestsPerBlock is reached. * * Default value is 5, please set a larger value when in poor network. - * - * @type {number} - * @memberof BlobDownloadToBufferOptions */ maxRetryRequestsPerBlock?: number; /** * Progress updater. - * - * @type {(progress: TransferProgressEvent) => void} - * @memberof BlobDownloadToBufferOptions */ onProgress?: (progress: TransferProgressEvent) => void; /** * Access conditions headers. - * - * @type {BlobRequestConditions} - * @memberof BlobDownloadToBufferOptions */ conditions?: BlobRequestConditions; /** * Concurrency of parallel download. - * - * @type {number} - * @memberof BlobDownloadToBufferOptions */ concurrency?: number; /** * Customer Provided Key Info. - * - * @type {CpkInfo} - * @memberof BlobDownloadToBufferOptions */ customerProvidedKey?: CpkInfo; } /** * Contains response data for the {@link BlobClient.deleteIfExists} operation. - * - * @export - * @interface BlobDeleteIfExistsResponse */ export interface BlobDeleteIfExistsResponse extends BlobDeleteResponse { /** * Indicate whether the blob is successfully deleted. Is false if the blob does not exist in the first place. - * - * @type {boolean} - * @memberof BlobDeleteIfExistsResponse */ succeeded: boolean; } /** * Contains response data for the {@link BlobClient.getProperties} operation. - * - * @export - * @interface BlobGetPropertiesResponse */ export interface BlobGetPropertiesResponse extends BlobGetPropertiesResponseModel { /** * Parsed Object Replication Policy Id, Rule Id(s) and status of the source blob. - * - * @type {ObjectReplicationPolicy[]} - * @memberof BlobGetPropertiesResponse */ objectReplicationSourceProperties?: ObjectReplicationPolicy[]; /** * Object Replication Policy Id of the destination blob. - * - * @type {string} - * @memberof BlobGetPropertiesResponse */ objectReplicationDestinationPolicyId?: string; } /** * Common options of {@link BlobGenerateSasUrlOptions} and {@link ContainerGenerateSasUrlOptions}. - * - * @export - * @interface CommonGenerateSasUrlOptions */ export interface CommonGenerateSasUrlOptions { /** * 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 CommonGenerateSasUrlOptions */ version?: string; /** * Optional. SAS protocols, HTTPS only or HTTPSandHTTP - * - * @type {SASProtocol} - * @memberof CommonGenerateSasUrlOptions */ protocol?: SASProtocol; /** * Optional. When the SAS will take effect. - * - * @type {Date} - * @memberof CommonGenerateSasUrlOptions */ startsOn?: Date; /** * Optional only when identifier is provided. The time after which the SAS will no longer work. - * - * @type {Date} - * @memberof CommonGenerateSasUrlOptions */ expiresOn?: Date; /** * Optional. IP ranges allowed in this SAS. - * - * @type {SasIPRange} - * @memberof CommonGenerateSasUrlOptions */ ipRange?: SasIPRange; @@ -1042,65 +720,41 @@ export interface CommonGenerateSasUrlOptions { * Optional. The name of the access policy on the container this SAS references if any. * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy - * - * @type {string} - * @memberof CommonGenerateSasUrlOptions */ identifier?: string; /** * Optional. The cache-control header for the SAS. - * - * @type {string} - * @memberof CommonGenerateSasUrlOptions */ cacheControl?: string; /** * Optional. The content-disposition header for the SAS. - * - * @type {string} - * @memberof CommonGenerateSasUrlOptions */ contentDisposition?: string; /** * Optional. The content-encoding header for the SAS. - * - * @type {string} - * @memberof CommonGenerateSasUrlOptions */ contentEncoding?: string; /** * Optional. The content-language header for the SAS. - * - * @type {string} - * @memberof CommonGenerateSasUrlOptions */ contentLanguage?: string; /** * Optional. The content-type header for the SAS. - * - * @type {string} - * @memberof CommonGenerateSasUrlOptions */ contentType?: string; } /** * Options to configure {@link BlobClient.generateSasUrl} operation. - * - * @export - * @interface BlobGenerateSasUrlOptions */ export interface BlobGenerateSasUrlOptions extends CommonGenerateSasUrlOptions { /** * Optional only when identifier is provided. Specifies the list of permissions to be associated with the SAS. - * - * @type {BlobSASPermissions} - * @memberof BlobGenerateSasUrlOptions */ permissions?: BlobSASPermissions; } @@ -1108,17 +762,10 @@ export interface BlobGenerateSasUrlOptions extends CommonGenerateSasUrlOptions { /** * A BlobClient represents a URL to an Azure Storage blob; the blob may be a block blob, * append blob, or page blob. - * - * @export - * @class BlobClient */ export class BlobClient extends StorageClient { /** * blobContext provided by protocol layer. - * - * @private - * @type {Blobs} - * @memberof BlobClient */ private blobContext: StorageBlob; @@ -1155,7 +802,6 @@ export class BlobClient extends StorageClient { * @param containerName - Container name. * @param blobName - Blob name. * @param options - Optional. Options to configure the HTTP pipeline. - * @memberof BlobClient */ constructor( connectionString: string, @@ -1172,9 +818,8 @@ export class BlobClient extends StorageClient { * @param url - A Client string pointing to Azure Storage blob service, such as * "https://myaccount.blob.core.windows.net". You can append a SAS * if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString". - * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. + * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. * @param options - Optional. Options to configure the HTTP pipeline. - * @memberof BlobClient */ constructor( url: string, @@ -1197,7 +842,6 @@ export class BlobClient extends StorageClient { * Such as a blob named "my?blob%", the URL should be "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25". * @param pipeline - Call newPipeline() to create a default * pipeline, or provide a customized pipeline. - * @memberof BlobClient */ constructor(url: string, pipeline: Pipeline); constructor( @@ -1297,7 +941,6 @@ export class BlobClient extends StorageClient { * * @param snapshot - The snapshot timestamp. * @returns A new BlobClient object identical to the source but with the specified snapshot timestamp - * @memberof BlobClient */ public withSnapshot(snapshot: string): BlobClient { return new BlobClient( @@ -1316,7 +959,6 @@ export class BlobClient extends StorageClient { * * @param versionId - The versionId. * @returns A new BlobClient object pointing to the version of this blob. - * @memberof BlobClient */ public withVersion(versionId: string): BlobClient { return new BlobClient( @@ -1332,8 +974,6 @@ export class BlobClient extends StorageClient { /** * Creates a AppendBlobClient object. * - * - * @memberof BlobClient */ public getAppendBlobClient(): AppendBlobClient { return new AppendBlobClient(this.url, this.pipeline); @@ -1342,8 +982,6 @@ export class BlobClient extends StorageClient { /** * Creates a BlockBlobClient object. * - * - * @memberof BlobClient */ public getBlockBlobClient(): BlockBlobClient { return new BlockBlobClient(this.url, this.pipeline); @@ -1352,8 +990,6 @@ export class BlobClient extends StorageClient { /** * Creates a PageBlobClient object. * - * - * @memberof BlobClient */ public getPageBlobClient(): PageBlobClient { return new PageBlobClient(this.url, this.pipeline); @@ -1368,11 +1004,10 @@ export class BlobClient extends StorageClient { * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob * - * @param offset - From which position of the blob to download, >= 0 - * @param count - How much data to be downloaded, > 0. Will download to the end when undefined + * @param offset - From which position of the blob to download, greater than or equal to 0 + * @param count - How much data to be downloaded, greater than 0. Will download to the end when undefined * @param options - Optional options to Blob Download operation. * - * @memberof BlobClient * * Example usage (Node.js): * @@ -1538,8 +1173,6 @@ export class BlobClient extends StorageClient { * function completes. * * @param options - options to Exists operation. - * - * @memberof BlobClient */ public async exists(options: BlobExistsOptions = {}): Promise { const { span, spanOptions } = createSpan("BlobClient-exists", options.tracingOptions); @@ -1584,8 +1217,6 @@ export class BlobClient extends StorageClient { * will retain their original casing. * * @param options - Optional options to Get Properties operation. - * - * @memberof BlobClient */ public async getProperties( options: BlobGetPropertiesOptions = {} @@ -1630,8 +1261,6 @@ export class BlobClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob * * @param options - Optional options to Blob Delete operation. - * - * @memberof BlobClient */ public async delete(options: BlobDeleteOptions = {}): Promise { const { span, spanOptions } = createSpan("BlobClient-delete", options.tracingOptions); @@ -1666,8 +1295,6 @@ export class BlobClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob * * @param options - Optional options to Blob Delete operation. - * - * @memberof BlobClient */ public async deleteIfExists( options: BlobDeleteOptions = {} @@ -1712,8 +1339,6 @@ export class BlobClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob * * @param options - Optional options to Blob Undelete operation. - * - * @memberof BlobClient */ public async undelete(options: BlobUndeleteOptions = {}): Promise { const { span, spanOptions } = createSpan("BlobClient-undelete", options.tracingOptions); @@ -1744,8 +1369,6 @@ export class BlobClient extends StorageClient { * the specified blob HTTP headers, these blob HTTP * headers without a value will be cleared. * @param options - Optional options to Blob Set HTTP Headers operation. - * - * @memberof BlobClient */ public async setHTTPHeaders( blobHTTPHeaders?: BlobHTTPHeaders, @@ -1787,8 +1410,6 @@ export class BlobClient extends StorageClient { * @param metadata - Replace existing metadata with this value. * If no value provided the existing metadata will be removed. * @param options - Optional options to Set Metadata operation. - * - * @memberof BlobClient */ public async setMetadata( metadata?: Metadata, @@ -1829,8 +1450,6 @@ export class BlobClient extends StorageClient { * * @param tags - * @param options - - * - * @memberof BlobClient */ public async setTags(tags: Tags, options: BlobSetTagsOptions = {}): Promise { const { span, spanOptions } = createSpan("BlobClient-setTags", options.tracingOptions); @@ -1860,8 +1479,6 @@ export class BlobClient extends StorageClient { * Gets the tags associated with the underlying blob. * * @param options - - * - * @memberof BlobClient */ public async getTags(options: BlobGetTagsOptions = {}): Promise { const { span, spanOptions } = createSpan("BlobClient-getTags", options.tracingOptions); @@ -1897,7 +1514,6 @@ export class BlobClient extends StorageClient { * * @param proposeLeaseId - Initial proposed lease Id. * @returns A new BlobLeaseClient object for managing leases on the blob. - * @memberof BlobClient */ public getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient { return new BlobLeaseClient(this, proposeLeaseId); @@ -1908,8 +1524,6 @@ export class BlobClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob * * @param options - Optional options to the Blob Create Snapshot operation. - * - * @memberof BlobClient */ public async createSnapshot( options: BlobCreateSnapshotOptions = {} @@ -2047,8 +1661,6 @@ export class BlobClient extends StorageClient { * * @param copyId - Id of the Copy From URL operation. * @param options - Optional options to the Blob Abort Copy From URL operation. - * - * @memberof BlobClient */ public async abortCopyFromURL( copyId: string, @@ -2079,8 +1691,6 @@ export class BlobClient extends StorageClient { * * @param copySource - The source URL to copy from, Shared Access Signature(SAS) maybe needed for authentication * @param options - - * - * @memberof BlobClient */ public async syncCopyFromURL( copySource: string, @@ -2130,8 +1740,6 @@ export class BlobClient extends StorageClient { * * @param tier - The tier to be set on the blob. Valid values are Hot, Cool, or Archive. * @param options - Optional options to the Blob Set Tier operation. - * - * @memberof BlobClient */ public async setAccessTier( tier: BlockBlobTier | PremiumPageBlobTier | string, @@ -2172,11 +1780,9 @@ export class BlobClient extends StorageClient { * gigabytes on 64-bit systems due to limitations of Node.js/V8. For blobs larger than this size, * consider {@link downloadToFile}. * - * @export * @param offset - From which position of the block blob to download(in bytes) * @param count - How much data(in bytes) to be downloaded. Will download to the end when passing undefined * @param options - BlobDownloadToBufferOptions - * */ public async downloadToBuffer( offset?: number, @@ -2194,12 +1800,10 @@ export class BlobClient extends StorageClient { * gigabytes on 64-bit systems due to limitations of Node.js/V8. For blobs larger than this size, * consider {@link downloadToFile}. * - * @export * @param buffer - Buffer to be fill, must have length larger than count * @param offset - From which position of the block blob to download(in bytes) * @param count - How much data(in bytes) to be downloaded. Will download to the end when passing undefined * @param options - BlobDownloadToBufferOptions - * */ public async downloadToBuffer( buffer: Buffer, @@ -2245,7 +1849,7 @@ export class BlobClient extends StorageClient { } if (count && count <= 0) { - throw new RangeError("count option must be > 0"); + throw new RangeError("count option must be greater than 0"); } if (!options.conditions) { @@ -2344,7 +1948,6 @@ export class BlobClient extends StorageClient { * but with readableStreamBody set to undefined since its * content is already read and written into a local file * at the specified path. - * @memberof BlobClient */ public async downloadToFile( filePath: string, @@ -2444,8 +2047,6 @@ export class BlobClient extends StorageClient { * * @param copySource - url to the source Azure Blob/File. * @param options - Optional options to the Blob Start Copy From URL operation. - * - * @memberof BlobClient */ private async startCopyFromURL( copySource: string, @@ -2498,7 +2099,6 @@ export class BlobClient extends StorageClient { * * @param options - Optional parameters. * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token. - * @memberof BlobClient */ public generateSasUrl(options: BlobGenerateSasUrlOptions): Promise { return new Promise((resolve) => { @@ -2526,46 +2126,28 @@ export class BlobClient extends StorageClient { /** * Options to configure {@link AppendBlobClient.create} operation. - * - * @export - * @interface AppendBlobCreateOptions */ export interface AppendBlobCreateOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof AppendBlobCreateOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when creating append blobs. - * - * @type {BlobRequestConditions} - * @memberof AppendBlobCreateOptions */ conditions?: BlobRequestConditions; /** * HTTP headers to set when creating append blobs. - * - * @type {BlobHTTPHeaders} - * @memberof AppendBlobCreateOptions */ blobHTTPHeaders?: BlobHTTPHeaders; /** * A collection of key-value string pair to associate with the blob when creating append blobs. - * - * @type {Metadata} - * @memberof AppendBlobCreateOptions */ metadata?: Metadata; /** * Customer Provided Key Info. - * - * @type {CpkInfo} - * @memberof AppendBlobCreateOptions */ customerProvidedKey?: CpkInfo; /** @@ -2573,54 +2155,33 @@ export interface AppendBlobCreateOptions extends CommonOptions { * encrypt the data provided in the request. If not specified, encryption is performed with the * default account encryption scope. For more information, see Encryption at Rest for Azure * Storage Services. - * - * @type {string} - * @memberof AppendBlobCreateOptions */ encryptionScope?: string; /** * Blob tags. - * - * @type {Tags} - * @memberof AppendBlobCreateOptions */ tags?: Tags; } /** * Options to configure {@link AppendBlobClient.createIfNotExists} operation. - * - * @export - * @interface AppendBlobCreateIfNotExistsOptions */ export interface AppendBlobCreateIfNotExistsOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof AppendBlobCreateIfNotExistsOptions */ abortSignal?: AbortSignalLike; /** * HTTP headers to set when creating append blobs. - * - * @type {BlobHTTPHeaders} - * @memberof AppendBlobCreateIfNotExistsOptions */ blobHTTPHeaders?: BlobHTTPHeaders; /** * A collection of key-value string pair to associate with the blob when creating append blobs. - * - * @type {Metadata} - * @memberof AppendBlobCreateIfNotExistsOptions */ metadata?: Metadata; /** * Customer Provided Key Info. - * - * @type {CpkInfo} - * @memberof AppendBlobCreateIfNotExistsOptions */ customerProvidedKey?: CpkInfo; /** @@ -2628,65 +2189,40 @@ export interface AppendBlobCreateIfNotExistsOptions extends CommonOptions { * encrypt the data provided in the request. If not specified, encryption is performed with the * default account encryption scope. For more information, see Encryption at Rest for Azure * Storage Services. - * - * @type {string} - * @memberof AppendBlobCreateIfNotExistsOptions */ encryptionScope?: string; } /** * Options to configure {@link AppendBlobClient.seal} operation. - * - * @export - * @interface AppendBlobSealOptions - * @extends {CommonOptions} */ export interface AppendBlobSealOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof AppendBlobAppendBlockOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet. - * - * @type {AppendBlobRequestConditions} - * @memberof AppendBlobAppendBlockOptions */ conditions?: AppendBlobRequestConditions; } /** * Options to configure the {@link AppendBlobClient.appendBlock} operation. - * - * @export - * @interface AppendBlobAppendBlockOptions */ export interface AppendBlobAppendBlockOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof AppendBlobAppendBlockOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when appending append blob blocks. - * - * @type {AppendBlobRequestConditions} - * @memberof AppendBlobAppendBlockOptions */ conditions?: AppendBlobRequestConditions; /** * Callback to receive events on the progress of append block operation. - * - * @type {(progress: TransferProgressEvent) => void} - * @memberof AppendBlobAppendBlockOptions */ onProgress?: (progress: TransferProgressEvent) => void; /** @@ -2694,9 +2230,6 @@ export interface AppendBlobAppendBlockOptions extends CommonOptions { * When this is specified, the storage service compares the hash of the content that has arrived with this value. * * transactionalContentMD5 and transactionalContentCrc64 cannot be set at same time. - * - * @type {Uint8Array} - * @memberof AppendBlobAppendBlockOptions */ transactionalContentMD5?: Uint8Array; /** @@ -2704,16 +2237,10 @@ export interface AppendBlobAppendBlockOptions extends CommonOptions { * When this is specified, the storage service compares the hash of the content that has arrived with this value. * * transactionalContentMD5 and transactionalContentCrc64 cannot be set at same time. - * - * @type {Uint8Array} - * @memberof AppendBlobAppendBlockOptions */ transactionalContentCrc64?: Uint8Array; /** * Customer Provided Key Info. - * - * @type {CpkInfo} - * @memberof AppendBlobAppendBlockOptions */ customerProvidedKey?: CpkInfo; /** @@ -2721,40 +2248,25 @@ export interface AppendBlobAppendBlockOptions extends CommonOptions { * encrypt the data provided in the request. If not specified, encryption is performed with the * default account encryption scope. For more information, see Encryption at Rest for Azure * Storage Services. - * - * @type {string} - * @memberof AppendBlobAppendBlockOptions */ encryptionScope?: string; } /** * Options to configure the {@link AppendBlobClient.appendBlockFromURL} operation. - * - * @export - * @interface AppendBlobAppendBlockFromURLOptions */ export interface AppendBlobAppendBlockFromURLOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof AppendBlobAppendBlockFromURLOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when appending append blob blocks. - * - * @type {AppendBlobRequestConditions} - * @memberof AppendBlobAppendBlockFromURLOptions */ conditions?: AppendBlobRequestConditions; /** * Conditions to meet for the source Azure Blob/File when copying from a URL to the blob. - * - * @type {MatchConditions & ModificationConditions} - * @memberof AppendBlobAppendBlockFromURLOptions */ sourceConditions?: MatchConditions & ModificationConditions; /** @@ -2763,9 +2275,6 @@ export interface AppendBlobAppendBlockFromURLOptions extends CommonOptions { * When this is specified, the storage service compares the hash of the content that has arrived from the copy-source with this value. * * sourceContentMD5 and sourceContentCrc64 cannot be set at same time. - * - * @type {Uint8Array} - * @memberof AppendBlobAppendBlockFromURLOptions */ sourceContentMD5?: Uint8Array; /** @@ -2774,16 +2283,10 @@ export interface AppendBlobAppendBlockFromURLOptions extends CommonOptions { * When this is specified, the storage service compares the hash of the content that has arrived from the copy-source with this value. * * sourceContentMD5 and sourceContentCrc64 cannot be set at same time. - * - * @type {Uint8Array} - * @memberof AppendBlobAppendBlockFromURLOptions */ sourceContentCrc64?: Uint8Array; /** * Customer Provided Key Info. - * - * @type {CpkInfo} - * @memberof AppendBlobAppendBlockFromURLOptions */ customerProvidedKey?: CpkInfo; /** @@ -2791,43 +2294,26 @@ export interface AppendBlobAppendBlockFromURLOptions extends CommonOptions { * encrypt the data provided in the request. If not specified, encryption is performed with the * default account encryption scope. For more information, see Encryption at Rest for Azure * Storage Services. - * - * @type {string} - * @memberof AppendBlobAppendBlockFromURLOptions */ encryptionScope?: string; } /** * Contains response data for the {@link appendBlobClient.createIfNotExists} operation. - * - * @export - * @interface AppendBlobCreateIfNotExistsResponse */ export interface AppendBlobCreateIfNotExistsResponse extends AppendBlobCreateResponse { /** * Indicate whether the blob is successfully created. Is false when the blob is not changed as it already exists. - * - * @type {boolean} - * @memberof AppendBlobCreateIfNotExistsResponse */ succeeded: boolean; } /** * AppendBlobClient defines a set of operations applicable to append blobs. - * - * @export - * @class AppendBlobClient - * @extends {BlobClient} */ export class AppendBlobClient extends BlobClient { /** * appendBlobsContext provided by protocol layer. - * - * @private - * @type {AppendBlob} - * @memberof AppendBlobClient */ private appendBlobContext: AppendBlob; @@ -2844,7 +2330,6 @@ export class AppendBlobClient extends BlobClient { * @param containerName - Container name. * @param blobName - Blob name. * @param options - Optional. Options to configure the HTTP pipeline. - * @memberof AppendBlobClient */ constructor( connectionString: string, @@ -2866,9 +2351,8 @@ export class AppendBlobClient extends BlobClient { * Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped. * However, if a blob name includes ? or %, blob name must be encoded in the URL. * Such as a blob named "my?blob%", the URL should be "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25". - * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. + * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. * @param options - Optional. Options to configure the HTTP pipeline. - * @memberof AppendBlobClient */ constructor( url: string, @@ -2891,7 +2375,6 @@ export class AppendBlobClient extends BlobClient { * Such as a blob named "my?blob%", the URL should be "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25". * @param pipeline - Call newPipeline() to create a default * pipeline, or provide a customized pipeline. - * @memberof AppendBlobClient */ constructor(url: string, pipeline: Pipeline); constructor( @@ -2985,7 +2468,6 @@ export class AppendBlobClient extends BlobClient { * * @param snapshot - The snapshot timestamp. * @returns A new AppendBlobClient object identical to the source but with the specified snapshot timestamp. - * @memberof AppendBlobClient */ public withSnapshot(snapshot: string): AppendBlobClient { return new AppendBlobClient( @@ -3004,7 +2486,6 @@ export class AppendBlobClient extends BlobClient { * * @param options - Options to the Append Block Create operation. * - * @memberof AppendBlobClient * * Example usage: * @@ -3050,8 +2531,6 @@ export class AppendBlobClient extends BlobClient { * @see https://docs.microsoft.com/rest/api/storageservices/put-blob * * @param options - - * - * @memberof AppendBlobClient */ public async createIfNotExists( options: AppendBlobCreateIfNotExistsOptions = {} @@ -3099,8 +2578,6 @@ export class AppendBlobClient extends BlobClient { * Seals the append blob, making it read only. * * @param options - - * - * @memberof AppendBlobClient */ public async seal(options: AppendBlobSealOptions = {}): Promise { const { span, spanOptions } = createSpan("AppendBlobClient-seal", options.tracingOptions); @@ -3135,7 +2612,6 @@ export class AppendBlobClient extends BlobClient { * @param contentLength - Length of the body in bytes. * @param options - Options to the Append Block operation. * - * @memberof AppendBlobClient * * Example usage: * @@ -3204,8 +2680,6 @@ export class AppendBlobClient extends BlobClient { * @param sourceOffset - Offset in source to be appended * @param count - Number of bytes to be appended as a block * @param options - - * - * @memberof AppendBlobClient */ public async appendBlockFromURL( sourceURL: string, @@ -3257,52 +2731,31 @@ export class AppendBlobClient extends BlobClient { /** * Options to configure {@link BlockBlobClient.upload} operation. - * - * @export - * @interface BlockBlobUploadOptions */ export interface BlockBlobUploadOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlockBlobUploadOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when uploading to the block blob. - * - * @type {BlobRequestConditions} - * @memberof BlockBlobUploadOptions */ conditions?: BlobRequestConditions; /** * HTTP headers to set when uploading to a block blob. - * - * @type {BlobHTTPHeaders} - * @memberof BlockBlobUploadOptions */ blobHTTPHeaders?: BlobHTTPHeaders; /** * A collection of key-value string pair to associate with the blob when uploading to a block blob. - * - * @type {Metadata} - * @memberof BlockBlobUploadOptions */ metadata?: Metadata; /** * Callback to receive events on the progress of upload operation. - * - * @type {(progress: TransferProgressEvent) => void} - * @memberof BlockBlobUploadOptions */ onProgress?: (progress: TransferProgressEvent) => void; /** * Customer Provided Key Info. - * - * @type {CpkInfo} - * @memberof BlockBlobUploadOptions */ customerProvidedKey?: CpkInfo; /** @@ -3310,48 +2763,31 @@ export interface BlockBlobUploadOptions extends CommonOptions { * encrypt the data provided in the request. If not specified, encryption is performed with the * default account encryption scope. For more information, see Encryption at Rest for Azure * Storage Services. - * - * @type {string} - * @memberof BlockBlobUploadOptions */ encryptionScope?: string; /** * Access tier. * More Details - https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers - * - * @type {BlockBlobTier | string} - * @memberof BlockBlobUploadOptions */ tier?: BlockBlobTier | string; /** * Blob tags. - * - * @type {Tags} - * @memberof BlockBlobUploadOptions */ tags?: Tags; } /** * Options to configure {@link BlockBlobClient.syncUploadFromURL} operation. - * - * @export - * @interface BlockBlobSyncUploadFromURLOptions */ export interface BlockBlobSyncUploadFromURLOptions extends CommonOptions { /** * Server timeout in seconds. * For more information, @see https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations - * @type {number} - * @memberof BlockBlobSyncUploadFromURLOptions */ timeoutInSeconds?: number; /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlockBlobSyncUploadFromURLOptions */ abortSignal?: AbortSignalLike; /** @@ -3362,9 +2798,6 @@ export interface BlockBlobSyncUploadFromURLOptions extends CommonOptions { * Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules * for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more * information. - * - * @type {Metadata} - * @memberof BlockBlobSyncUploadFromURLOptions */ metadata?: Metadata; /** @@ -3372,231 +2805,139 @@ export interface BlockBlobSyncUploadFromURLOptions extends CommonOptions { * encrypt the data provided in the request. If not specified, encryption is performed with the * default account encryption scope. For more information, see Encryption at Rest for Azure * Storage Services. - * - * @type {string} - * @memberof BlockBlobSyncUploadFromURLOptions */ encryptionScope?: string; /** * Access tier. * More Details - https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers - * - * @type {BlockBlobTier | string} - * @memberof BlockBlobSyncUploadFromURLOptions */ tier?: BlockBlobTier | string; /** * Specify the md5 calculated for the range of bytes that must be read from the copy source. - * @type {Uint8Array} - * @memberof BlockBlobSyncUploadFromURLOptions */ sourceContentMD5?: Uint8Array; /** * Blob tags. - * - * @type {Tags} - * @memberof BlockBlobSyncUploadFromURLOptions */ tags?: Tags; /** * Optional, default is true. Indicates if properties from the source blob should be copied. - * - * @type {boolean} - * @memberof BlockBlobSyncUploadFromURLOptions */ copySourceBlobProperties?: boolean; /** * HTTP headers to set when uploading to a block blob. - * - * @type {BlobHTTPHeaders} - * @memberof BlockBlobSyncUploadFromURLOptions */ blobHTTPHeaders?: BlobHTTPHeaders; /** * Conditions to meet for the destination Azure Blob. - * - * @type {BlobRequestConditions} - * @memberof BlockBlobSyncUploadFromURLOptions */ conditions?: BlobRequestConditions; /** * Customer Provided Key Info. - * - * @type {CpkInfo} - * @memberof BlockBlobSyncUploadFromURLOptions */ customerProvidedKey?: CpkInfo; /** * Optional. Conditions to meet for the source Azure Blob. - * - * @type {ModifiedAccessConditions} - * @memberof BlockBlobSyncUploadFromURLOptions */ sourceConditions?: ModifiedAccessConditions; } /** * Blob query error type. - * - * @export - * @interface BlobQueryError */ export interface BlobQueryError { /** * Whether error is fatal. Fatal error will stop query. - * - * @type {boolean} - * @memberof BlobQueryError */ isFatal: boolean; /** * Error name. - * - * @type {string} - * @memberof BlobQueryError */ name: string; /** * Position in bytes of the query. - * - * @type {number} - * @memberof BlobQueryError */ position: number; /** * Error description. - * - * @type {string} - * @memberof BlobQueryError */ description: string; } /** * Options to query blob with JSON format. - * - * @export - * @interface BlobQueryJsonTextConfiguration */ export interface BlobQueryJsonTextConfiguration { /** * Record separator. - * - * @type {string} - * @memberof BlobQueryJsonTextConfiguration */ recordSeparator: string; /** * Query for a JSON format blob. - * - * @type {"json"} - * @memberof BlobQueryJsonTextConfiguration */ kind: "json"; } /** * Options to query blob with CSV format. - * - * @export - * @interface BlobQueryCsvTextConfiguration */ export interface BlobQueryCsvTextConfiguration { /** * Record separator. - * - * @type {string} - * @memberof BlobQueryCsvTextConfiguration */ recordSeparator: string; /** * Query for a CSV format blob. - * - * @type {"csv"} - * @memberof BlobQueryCsvTextConfiguration */ kind: "csv"; /** * Column separator. Default is ",". - * - * @type {string} - * @memberof BlobQueryCsvTextConfiguration */ columnSeparator?: string; /** * Field quote. - * - * @type {string} - * @memberof BlobQueryCsvTextConfiguration */ fieldQuote?: string; /** * Escape character. - * - * @type {string} - * @memberof BlobQueryCsvTextConfiguration */ escapeCharacter?: string; /** * Has headers. Default is false. - * - * @type {boolean} - * @memberof BlobQueryCsvTextConfiguration */ hasHeaders?: boolean; } /** * Options to query blob with Apache Arrow format. Only valid for {@link BlockBlobQueryOptions.outputTextConfiguration}. - * - * @export - * @interface BlobQueryArrowConfiguration */ export interface BlobQueryArrowConfiguration { /** * Kind. - * - * @type {"arrow"} - * @memberof BlobQueryArrowConfiguration */ kind: "arrow"; /** * List of {@link BlobQueryArrowField} describing the schema of the data. - * - * @type {BlobQueryArrowField[]} - * @memberof BlobQueryArrowConfiguration */ schema: BlobQueryArrowField[]; } /** * Options to configure {@link BlockBlobClient.query} operation. - * - * @export - * @interface BlockBlobQueryOptions */ export interface BlockBlobQueryOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlockBlobQueryOptions */ abortSignal?: AbortSignalLike; /** * Configurations for the query input. - * - * @type {BlobQueryJsonTextConfiguration | BlobQueryCsvTextConfiguration} - * @memberof BlockBlobQueryOptions */ inputTextConfiguration?: BlobQueryJsonTextConfiguration | BlobQueryCsvTextConfiguration; /** * Configurations for the query output. - * - * @type {BlobQueryJsonTextConfiguration | BlobQueryCsvTextConfiguration| BlobQueryArrowConfiguration} - * @memberof BlockBlobQueryOptions */ outputTextConfiguration?: | BlobQueryJsonTextConfiguration @@ -3604,61 +2945,38 @@ export interface BlockBlobQueryOptions extends CommonOptions { | BlobQueryArrowConfiguration; /** * Callback to receive events on the progress of query operation. - * - * @type {(progress: TransferProgressEvent) => void} - * @memberof BlockBlobQueryOptions */ onProgress?: (progress: TransferProgressEvent) => void; /** * Callback to receive error events during the query operaiton. - * - * @memberof BlockBlobQueryOptions */ onError?: (error: BlobQueryError) => void; /** * Conditions to meet when uploading to the block blob. - * - * @type {BlobRequestConditions} - * @memberof BlockBlobQueryOptions */ conditions?: BlobRequestConditions; /** * Customer Provided Key Info. - * - * @type {CpkInfo} - * @memberof BlockBlobQueryOptions */ customerProvidedKey?: CpkInfo; } /** * Options to configure {@link BlockBlobClient.stageBlock} operation. - * - * @export - * @interface BlockBlobStageBlockOptions */ export interface BlockBlobStageBlockOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlockBlobStageBlockOptions */ abortSignal?: AbortSignalLike; /** * If specified, contains the lease id that must be matched and lease with this id * must be active in order for the operation to succeed. - * - * @type {LeaseAccessConditions} - * @memberof BlockBlobStageBlockOptions */ conditions?: LeaseAccessConditions; /** * Callback to receive events on the progress of stage block operation. - * - * @type {(progress: TransferProgressEvent) => void} - * @memberof BlockBlobStageBlockOptions */ onProgress?: (progress: TransferProgressEvent) => void; /** @@ -3666,9 +2984,6 @@ export interface BlockBlobStageBlockOptions extends CommonOptions { * When this is specified, the storage service compares the hash of the content that has arrived with this value. * * transactionalContentMD5 and transactionalContentCrc64 cannot be set at same time. - * - * @type {Uint8Array} - * @memberof BlockBlobStageBlockOptions */ transactionalContentMD5?: Uint8Array; @@ -3677,16 +2992,10 @@ export interface BlockBlobStageBlockOptions extends CommonOptions { * When this is specified, the storage service compares the hash of the content that has arrived with this value. * * transactionalContentMD5 and transactionalContentCrc64 cannot be set at same time. - * - * @type {Uint8Array} - * @memberof BlockBlobStageBlockOptions */ transactionalContentCrc64?: Uint8Array; /** * Customer Provided Key Info. - * - * @type {CpkInfo} - * @memberof BlockBlobStageBlockOptions */ customerProvidedKey?: CpkInfo; /** @@ -3694,42 +3003,27 @@ export interface BlockBlobStageBlockOptions extends CommonOptions { * encrypt the data provided in the request. If not specified, encryption is performed with the * default account encryption scope. For more information, see Encryption at Rest for Azure * Storage Services. - * - * @type {string} - * @memberof BlockBlobStageBlockOptions */ encryptionScope?: string; } /** * Options to configure {@link BlockBlobClient.stageBlockFromURL} operation. - * - * @export - * @interface BlockBlobStageBlockFromURLOptions */ export interface BlockBlobStageBlockFromURLOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlockBlobStageBlockFromURLOptions */ abortSignal?: AbortSignalLike; /** * Specifies the bytes of the source Blob/File to upload. * If not specified, the entire content is uploaded as a single block. - * - * @type {Range} - * @memberof BlockBlobStageBlockFromURLOptions */ range?: Range; /** * If specified, contains the lease id that must be matched and lease with this id * must be active in order for the operation to succeed. - * - * @type {LeaseAccessConditions} - * @memberof BlockBlobStageBlockFromURLOptions */ conditions?: LeaseAccessConditions; /** @@ -3738,9 +3032,6 @@ export interface BlockBlobStageBlockFromURLOptions extends CommonOptions { * When this is specified, the storage service compares the hash of the content that has arrived from the copy-source with this value. * * sourceContentMD5 and sourceContentCrc64 cannot be set at same time. - * - * @type {Uint8Array} - * @memberof BlockBlobStageBlockFromURLOptions */ sourceContentMD5?: Uint8Array; /** @@ -3749,15 +3040,10 @@ export interface BlockBlobStageBlockFromURLOptions extends CommonOptions { * When this is specified, the storage service compares the hash of the content that has arrived from the copy-source with this value. * * sourceContentMD5 and sourceContentCrc64 cannot be set at same time. - * @type {Uint8Array} - * @memberof BlockBlobStageBlockFromURLOptions */ sourceContentCrc64?: Uint8Array; /** * Customer Provided Key Info. - * - * @type {CpkInfo} - * @memberof BlockBlobStageBlockFromURLOptions */ customerProvidedKey?: CpkInfo; /** @@ -3765,54 +3051,33 @@ export interface BlockBlobStageBlockFromURLOptions extends CommonOptions { * encrypt the data provided in the request. If not specified, encryption is performed with the * default account encryption scope. For more information, see Encryption at Rest for Azure * Storage Services. - * - * @type {string} - * @memberof BlockBlobStageBlockFromURLOptions */ encryptionScope?: string; } /** * Options to configure {@link BlockBlobClient.commitBlockList} operation. - * - * @export - * @interface BlockBlobCommitBlockListOptions */ export interface BlockBlobCommitBlockListOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlockBlobCommitBlockListOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when committing the block list. - * - * @type {BlobRequestConditions} - * @memberof BlockBlobCommitBlockListOptions */ conditions?: BlobRequestConditions; /** * HTTP headers to set when committing block list. - * - * @type {BlobHTTPHeaders} - * @memberof BlockBlobCommitBlockListOptions */ blobHTTPHeaders?: BlobHTTPHeaders; /** * A collection of key-value string pair to associate with the blob when committing block list. - * - * @type {Metadata} - * @memberof BlockBlobCommitBlockListOptions */ metadata?: Metadata; /** * Customer Provided Key Info. - * - * @type {CpkInfo} - * @memberof BlockBlobCommitBlockListOptions */ customerProvidedKey?: CpkInfo; /** @@ -3820,99 +3085,63 @@ export interface BlockBlobCommitBlockListOptions extends CommonOptions { * encrypt the data provided in the request. If not specified, encryption is performed with the * default account encryption scope. For more information, see Encryption at Rest for Azure * Storage Services. - * - * @type {string} - * @memberof BlockBlobCommitBlockListOptions */ encryptionScope?: string; /** * Access tier. * More Details - https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers - * - * @type {BlockBlobTier | string} - * @memberof BlockBlobCommitBlockListOptions */ tier?: BlockBlobTier | string; /** * Blob tags. - * - * @type {Tags} - * @memberof BlockBlobCommitBlockListOptions */ tags?: Tags; } /** * Options to configure {@link BlockBlobClient.getBlockList} operation. - * - * @export - * @interface BlockBlobGetBlockListOptions */ export interface BlockBlobGetBlockListOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlockBlobGetBlockListOptions */ abortSignal?: AbortSignalLike; /** * If specified, contains the lease id that must be matched and lease with this id * must be active in order for the operation to succeed. - * - * @type {LeaseAccessConditions & TagConditions} - * @memberof BlockBlobGetBlockListOptions */ conditions?: LeaseAccessConditions & TagConditions; } /** * Option interface for the {@link BlockBlobClient.uploadStream} operation. - * - * @export - * @interface BlockBlobUploadStreamOptions */ export interface BlockBlobUploadStreamOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlockBlobUploadStreamOptions */ abortSignal?: AbortSignalLike; /** * Blob HTTP Headers. - * - * @type {BlobHTTPHeaders} - * @memberof BlockBlobUploadStreamOptions */ blobHTTPHeaders?: BlobHTTPHeaders; /** * Metadata of block blob. - * - * @type {{ [propertyName: string]: string }} - * @memberof BlockBlobUploadStreamOptions */ metadata?: { [propertyName: string]: string }; /** * Access conditions headers. - * - * @type {BlobRequestConditions} - * @memberof BlockBlobUploadStreamOptions */ conditions?: BlobRequestConditions; /** * Progress updater. - * - * @type {(progress: TransferProgressEvent) => void} - * @memberof BlockBlobUploadStreamOptions */ onProgress?: (progress: TransferProgressEvent) => void; @@ -3921,50 +3150,32 @@ export interface BlockBlobUploadStreamOptions extends CommonOptions { * encrypt the data provided in the request. If not specified, encryption is performed with the * default account encryption scope. For more information, see Encryption at Rest for Azure * Storage Services. - * - * @type {string} - * @memberof BlockBlobUploadStreamOptions */ encryptionScope?: string; /** * Blob tags. - * - * @type {Tags} - * @memberof BlockBlobUploadStreamOptions */ tags?: Tags; /** * Access tier. * More Details - https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers - * - * @type {BlockBlobTier | string} - * @memberof BlockBlobUploadStreamOptions */ tier?: BlockBlobTier | string; } /** * Option interface for {@link BlockBlobClient.uploadFile} and {@link BlockBlobClient.uploadSeekableStream}. - * - * @export - * @interface BlockBlobParallelUploadOptions */ export interface BlockBlobParallelUploadOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlockBlobParallelUploadOptions */ abortSignal?: AbortSignalLike; /** * Destination block blob size in bytes. - * - * @type {number} - * @memberof BlockBlobParallelUploadOptions */ blockSize?: number; @@ -3973,49 +3184,31 @@ export interface BlockBlobParallelUploadOptions extends CommonOptions { * Default value is 256MB, blob size less than this option will * be uploaded via one I/O operation without concurrency. * You can customize a value less equal than the default value. - * - * @type {number} - * @memberof BlockBlobParallelUploadOptions */ maxSingleShotSize?: number; /** * Progress updater. - * - * @type {(progress: TransferProgressEvent) => void} - * @memberof BlockBlobParallelUploadOptions */ onProgress?: (progress: TransferProgressEvent) => void; /** * Blob HTTP Headers. - * - * @type {BlobHTTPHeaders} - * @memberof BlockBlobParallelUploadOptions */ blobHTTPHeaders?: BlobHTTPHeaders; /** * Metadata of block blob. - * - * @type {{ [propertyName: string]: string }} - * @memberof BlockBlobParallelUploadOptions */ metadata?: { [propertyName: string]: string }; /** * Access conditions headers. - * - * @type {BlobRequestConditions} - * @memberof BlockBlobParallelUploadOptions */ conditions?: BlobRequestConditions; /** - * Concurrency of parallel uploading. Must be >= 0. - * - * @type {number} - * @memberof BlockBlobParallelUploadOptions + * Concurrency of parallel uploading. Must be greater than or equal to 0. */ concurrency?: number; @@ -4024,26 +3217,17 @@ export interface BlockBlobParallelUploadOptions extends CommonOptions { * encrypt the data provided in the request. If not specified, encryption is performed with the * default account encryption scope. For more information, see Encryption at Rest for Azure * Storage Services. - * - * @type {string} - * @memberof BlockBlobParallelUploadOptions */ encryptionScope?: string; /** * Blob tags. - * - * @type {Tags} - * @memberof BlockBlobParallelUploadOptions */ tags?: Tags; /** * Access tier. * More Details - https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers - * - * @type {BlockBlobTier | string} - * @memberof BlockBlobParallelUploadOptions */ tier?: BlockBlobTier | string; } @@ -4051,25 +3235,16 @@ export interface BlockBlobParallelUploadOptions extends CommonOptions { /** * Response type for {@link BlockBlobClient.uploadFile}, {@link BlockBlobClient.uploadStream}, and * {@link BlockBlobClient.uploadBrowserDate}. - * - * @export */ export type BlobUploadCommonResponse = BlockBlobUploadHeaders & { /** * The underlying HTTP response. - * - * @type {HttpResponse} - * @memberof BlobUploadCommonResponse */ _response: HttpResponse; }; /** * BlockBlobClient defines a set of operations applicable to block blobs. - * - * @export - * @class BlockBlobClient - * @extends {BlobClient} */ export class BlockBlobClient extends BlobClient { /** @@ -4077,19 +3252,11 @@ export class BlockBlobClient extends BlobClient { * * Note. Ideally BlobClient should set BlobClient.blobContext to protected. However, API * extractor has issue blocking that. Here we redecelare _blobContext in BlockBlobClient. - * - * @private - * @type {Blobs} - * @memberof BlobClient */ private _blobContext: StorageBlob; /** * blockBlobContext provided by protocol layer. - * - * @private - * @type {BlockBlobs} - * @memberof BlockBlobClient */ private blockBlobContext: BlockBlob; @@ -4106,7 +3273,6 @@ export class BlockBlobClient extends BlobClient { * @param containerName - Container name. * @param blobName - Blob name. * @param options - Optional. Options to configure the HTTP pipeline. - * @memberof BlockBlobClient */ constructor( connectionString: string, @@ -4128,9 +3294,8 @@ export class BlockBlobClient extends BlobClient { * Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped. * However, if a blob name includes ? or %, blob name must be encoded in the URL. * Such as a blob named "my?blob%", the URL should be "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25". - * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. + * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. * @param options - Optional. Options to configure the HTTP pipeline. - * @memberof BlockBlobClient */ constructor( url: string, @@ -4153,7 +3318,6 @@ export class BlockBlobClient extends BlobClient { * Such as a blob named "my?blob%", the URL should be "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25". * @param pipeline - Call newPipeline() to create a default * pipeline, or provide a customized pipeline. - * @memberof BlockBlobClient */ constructor(url: string, pipeline: Pipeline); constructor( @@ -4248,7 +3412,6 @@ export class BlockBlobClient extends BlobClient { * * @param snapshot - The snapshot timestamp. * @returns A new BlockBlobClient object identical to the source but with the specified snapshot timestamp. - * @memberof BlockBlobClient */ public withSnapshot(snapshot: string): BlockBlobClient { return new BlockBlobClient( @@ -4290,8 +3453,6 @@ export class BlockBlobClient extends BlobClient { * * @param query - * @param options - - * - * @memberof BlockBlobClient */ public async query( query: string, @@ -4355,7 +3516,6 @@ export class BlockBlobClient extends BlobClient { * string including non non-Base64/Hex-encoded characters. * @param options - Options to the Block Blob Upload operation. * @returns Response data for the Block Blob Upload operation. - * @memberof BlockBlobClient * * Example usage: * @@ -4417,8 +3577,6 @@ export class BlockBlobClient extends BlobClient { * - https://myaccount.blob.core.windows.net/mycontainer/myblob * - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot= * @param options - Optional parameters. - * @returns Promise - * @memberof BlockBlobClient */ public async syncUploadFromURL( @@ -4472,7 +3630,6 @@ export class BlockBlobClient extends BlobClient { * @param contentLength - Number of bytes to upload. * @param options - Options to the Block Blob Stage Block operation. * @returns Response data for the Block Blob Stage Block operation. - * @memberof BlockBlobClient */ public async stageBlock( blockId: string, @@ -4520,11 +3677,10 @@ export class BlockBlobClient extends BlobClient { * to perform the operation. Here are some examples of source object URLs: * - https://myaccount.blob.core.windows.net/mycontainer/myblob * - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot= - * @param offset - From which position of the blob to download, >= 0 - * @param count - How much data to be downloaded, > 0. Will download to the end when undefined + * @param offset - From which position of the blob to download, greater than or equal to 0 + * @param count - How much data to be downloaded, greater than 0. Will download to the end when undefined * @param options - Options to the Block Blob Stage Block From URL operation. * @returns Response data for the Block Blob Stage Block From URL operation. - * @memberof BlockBlobClient */ public async stageBlockFromURL( blockId: string, @@ -4571,7 +3727,6 @@ export class BlockBlobClient extends BlobClient { * @param blocks - Array of 64-byte value that is base64-encoded * @param options - Options to the Block Blob Commit Block List operation. * @returns Response data for the Block Blob Commit Block List operation. - * @memberof BlockBlobClient */ public async commitBlockList( blocks: string[], @@ -4622,7 +3777,6 @@ export class BlockBlobClient extends BlobClient { * the list of uncommitted blocks, or both lists together. * @param options - Options to the Block Blob Get Block List operation. * @returns Response data for the Block Blob Get Block List operation. - * @memberof BlockBlobClient */ public async getBlockList( listType: BlockListType, @@ -4673,11 +3827,8 @@ export class BlockBlobClient extends BlobClient { * Otherwise, this method will call {@link stageBlock} to upload blocks, and finally call {@link commitBlockList} * to commit the block list. * - * @export * @param data - Buffer(Node.js), Blob, ArrayBuffer or ArrayBufferView * @param options - - * - * @memberof BlockBlobClient */ public async uploadData( data: Buffer | Blob | ArrayBuffer | ArrayBufferView, @@ -4728,17 +3879,15 @@ export class BlockBlobClient extends BlobClient { * * Uploads a browser Blob/File/ArrayBuffer/ArrayBufferView object to block blob. * - * When buffer length <= 256MB, this method will use 1 upload call to finish the upload. + * When buffer length lesser than or equal to 256MB, this method will use 1 upload call to finish the upload. * Otherwise, this method will call {@link stageBlock} to upload blocks, and finally call * {@link commitBlockList} to commit the block list. * * @deprecated Use {@link uploadData} instead. * - * @export * @param browserData - Blob, File, ArrayBuffer or ArrayBufferView * @param options - Options to upload browser data. * @returns Response data for the Blob Upload operation. - * @memberof BlockBlobClient */ public async uploadBrowserData( browserData: Blob | ArrayBuffer | ArrayBufferView, @@ -4780,7 +3929,6 @@ export class BlockBlobClient extends BlobClient { * @param size - size of the data to upload. * @param options - Options to Upload to Block Blob operation. * @returns Response data for the Blob Upload operation. - * @memberof BlockBlobClient */ private async uploadSeekableInternal( bodyFactory: (offset: number, size: number) => HttpRequestBody, @@ -4899,14 +4047,13 @@ export class BlockBlobClient extends BlobClient { * * Uploads a local file in blocks to a block blob. * - * When file size <= 256MB, this method will use 1 upload call to finish the upload. + * When file size lesser than or equal to 256MB, this method will use 1 upload call to finish the upload. * Otherwise, this method will call stageBlock to upload blocks, and finally call commitBlockList * to commit the block list. * * @param filePath - Full path of local file * @param options - Options to Upload to Block Blob operation. * @returns Response data for the Blob Upload operation. - * @memberof BlockBlobClient */ public async uploadFile( filePath: string, @@ -4953,7 +4100,6 @@ export class BlockBlobClient extends BlobClient { * positive correlation with max uploading concurrency. Default value is 5 * @param options - Options to Upload Stream to Block Blob operation. * @returns Response data for the Blob Upload operation. - * @memberof BlockBlobClient */ public async uploadStream( stream: Readable, @@ -5026,53 +4172,32 @@ export class BlockBlobClient extends BlobClient { /** * Options to configure the {@link PageBlobClient.create} operation. - * - * @export - * @interface PageBlobCreateOptions */ export interface PageBlobCreateOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof PageBlobCreateOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when creating a page blob. - * - * @type {BlobRequestConditions} - * @memberof PageBlobCreateOptions */ conditions?: BlobRequestConditions; /** * A user-controlled value that can be used to track requests. * The value must be between 0 and 2^63 - 1. The default value is 0. - * - * @type {number} - * @memberof PageBlobCreateOptions */ blobSequenceNumber?: number; /** * HTTP headers to set when creating a page blob. - * - * @type {BlobHTTPHeaders} - * @memberof PageBlobCreateOptions */ blobHTTPHeaders?: BlobHTTPHeaders; /** * A collection of key-value string pair to associate with the blob when creating append blobs. - * - * @type {Metadata} - * @memberof PageBlobCreateOptions */ metadata?: Metadata; /** * Customer Provided Key Info. - * - * @type {CpkInfo} - * @memberof PageBlobCreateOptions */ customerProvidedKey?: CpkInfo; /** @@ -5080,70 +4205,43 @@ export interface PageBlobCreateOptions extends CommonOptions { * encrypt the data provided in the request. If not specified, encryption is performed with the * default account encryption scope. For more information, see Encryption at Rest for Azure * Storage Services. - * - * @type {string} - * @memberof PageBlobCreateOptions */ encryptionScope?: string; /** * Access tier. * More Details - https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers - * - * @type {PremiumPageBlobTier | string} - * @memberof PageBlobCreateOptions */ tier?: PremiumPageBlobTier | string; /** * Blob tags. - * - * @type {Tags} - * @memberof PageBlobCreateOptions */ tags?: Tags; } /** * Options to configure the {@link PageBlobClient.createIfNotExists} operation. - * - * @export - * @interface PageBlobCreateIfNotExistsOptions */ export interface PageBlobCreateIfNotExistsOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof PageBlobCreateIfNotExistsOptions */ abortSignal?: AbortSignalLike; /** * A user-controlled value that can be used to track requests. * The value must be between 0 and 2^63 - 1. The default value is 0. - * - * @type {number} - * @memberof PageBlobCreateIfNotExistsOptions */ blobSequenceNumber?: number; /** * HTTP headers to set when creating a page blob. - * - * @type {BlobHTTPHeaders} - * @memberof PageBlobCreateIfNotExistsOptions */ blobHTTPHeaders?: BlobHTTPHeaders; /** * A collection of key-value string pair to associate with the blob when creating append blobs. - * - * @type {Metadata} - * @memberof PageBlobCreateIfNotExistsOptions */ metadata?: Metadata; /** * Customer Provided Key Info. - * - * @type {CpkInfo} - * @memberof PageBlobCreateIfNotExistsOptions */ customerProvidedKey?: CpkInfo; /** @@ -5151,48 +4249,30 @@ export interface PageBlobCreateIfNotExistsOptions extends CommonOptions { * encrypt the data provided in the request. If not specified, encryption is performed with the * default account encryption scope. For more information, see Encryption at Rest for Azure * Storage Services. - * - * @type {string} - * @memberof PageBlobCreateIfNotExistsOptions */ encryptionScope?: string; /** * Access tier. * More Details - https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers - * - * @type {PremiumPageBlobTier | string} - * @memberof PageBlobCreateIfNotExistsOptions */ tier?: PremiumPageBlobTier | string; } /** * Options to configure the {@link PageBlobClient.uploadPages} operation. - * - * @export - * @interface PageBlobUploadPagesOptions */ export interface PageBlobUploadPagesOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof PageBlobUploadPagesOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when uploading pages. - * - * @type {PageBlobRequestConditions} - * @memberof PageBlobUploadPagesOptions */ conditions?: PageBlobRequestConditions; /** * Callback to receive events on the progress of upload pages operation. - * - * @type {(progress: TransferProgressEvent) => void} - * @memberof PageBlobUploadPagesOptions */ onProgress?: (progress: TransferProgressEvent) => void; /** @@ -5200,9 +4280,6 @@ export interface PageBlobUploadPagesOptions extends CommonOptions { * When this is specified, the storage service compares the hash of the content that has arrived with this value. * * transactionalContentMD5 and transactionalContentCrc64 cannot be set at same time. - * - * @type {Uint8Array} - * @memberof PageBlobUploadPagesOptions */ transactionalContentMD5?: Uint8Array; /** @@ -5210,16 +4287,10 @@ export interface PageBlobUploadPagesOptions extends CommonOptions { * When this is specified, the storage service compares the hash of the content that has arrived with this value. * * transactionalContentMD5 and transactionalContentCrc64 cannot be set at same time. - * - * @type {Uint8Array} - * @memberof PageBlobUploadPagesOptions */ transactionalContentCrc64?: Uint8Array; /** * Customer Provided Key Info. - * - * @type {CpkInfo} - * @memberof PageBlobUploadPagesOptions */ customerProvidedKey?: CpkInfo; /** @@ -5227,40 +4298,25 @@ export interface PageBlobUploadPagesOptions extends CommonOptions { * encrypt the data provided in the request. If not specified, encryption is performed with the * default account encryption scope. For more information, see Encryption at Rest for Azure * Storage Services. - * - * @type {string} - * @memberof PageBlobUploadPagesOptions */ encryptionScope?: string; } /** * Options to configure the {@link PageBlobClient.clearPages} operation. - * - * @export - * @interface PageBlobClearPagesOptions */ export interface PageBlobClearPagesOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof PageBlobClearPagesOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when clearing pages. - * - * @type {PageBlobRequestConditions} - * @memberof PageBlobClearPagesOptions */ conditions?: PageBlobRequestConditions; /** * Customer Provided Key Info. - * - * @type {CpkInfo} - * @memberof PageBlobClearPagesOptions */ customerProvidedKey?: CpkInfo; /** @@ -5268,88 +4324,55 @@ export interface PageBlobClearPagesOptions extends CommonOptions { * encrypt the data provided in the request. If not specified, encryption is performed with the * default account encryption scope. For more information, see Encryption at Rest for Azure * Storage Services. - * - * @type {string} - * @memberof PageBlobClearPagesOptions */ encryptionScope?: string; } /** * Options to configure the {@link PageBlobClient.getPageRanges} operation. - * - * @export - * @interface PageBlobGetPageRangesOptions */ export interface PageBlobGetPageRangesOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof PageBlobGetPageRangesOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when getting page ranges. - * - * @type {BlobRequestConditions} - * @memberof PageBlobGetPageRangesOptions */ conditions?: BlobRequestConditions; } /** * Options to configure the {@link PageBlobClient.getRangesDiff} operation. - * - * @export - * @interface PageBlobGetPageRangesDiffOptions */ export interface PageBlobGetPageRangesDiffOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof PageBlobGetPageRangesDiffOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when getting page ranges diff. - * - * @type {BlobRequestConditions} - * @memberof PageBlobGetPageRangesDiffOptions */ conditions?: BlobRequestConditions; /** * (unused) - * - * @type {string} - * @memberof PageBlobGetPageRangesDiffOptions */ range?: string; } /** * Options to configure {@link PageBlobClient.resize} operation. - * - * @export - * @interface PageBlobResizeOptions */ export interface PageBlobResizeOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof PageBlobResizeOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when resizing a page blob. - * - * @type {BlobRequestConditions} - * @memberof PageBlobResizeOptions */ conditions?: BlobRequestConditions; /** @@ -5357,88 +4380,55 @@ export interface PageBlobResizeOptions extends CommonOptions { * encrypt the data provided in the request. If not specified, encryption is performed with the * default account encryption scope. For more information, see Encryption at Rest for Azure * Storage Services. - * - * @type {string} - * @memberof PageBlobResizeOptions */ encryptionScope?: string; } /** * Options to configure {@link PageBlobClient.updateSequenceNumber} operation. - * - * @export - * @interface PageBlobUpdateSequenceNumberOptions */ export interface PageBlobUpdateSequenceNumberOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof PageBlobUpdateSequenceNumberOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when updating sequence number. - * - * @type {BlobRequestConditions} - * @memberof PageBlobUpdateSequenceNumberOptions */ conditions?: BlobRequestConditions; } /** * Options to configure {@link PageBlobClient.startCopyIncremental} operation. - * - * @export - * @interface PageBlobStartCopyIncrementalOptions */ export interface PageBlobStartCopyIncrementalOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof PageBlobStartCopyIncrementalOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when starting a copy incremental operation. - * - * @type {ModifiedAccessConditions} - * @memberof PageBlobStartCopyIncrementalOptions */ conditions?: ModifiedAccessConditions; } /** * Options to configure {@link PageBlobClient.uploadPagesFromURL} operation. - * - * @export - * @interface PageBlobUploadPagesFromURLOptions */ export interface PageBlobUploadPagesFromURLOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof PageBlobUploadPagesFromURLOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when updating sequence number. - * - * @type {PageBlobRequestConditions} - * @memberof PageBlobUploadPagesFromURLOptions */ conditions?: PageBlobRequestConditions; /** * Conditions to meet for the source Azure Blob/File when copying from a URL to the blob. - * - * @type {MatchConditions & ModificationConditions} - * @memberof PageBlobUploadPagesFromURLOptions */ sourceConditions?: MatchConditions & ModificationConditions; /** @@ -5447,9 +4437,6 @@ export interface PageBlobUploadPagesFromURLOptions extends CommonOptions { * When this is specified, the storage service compares the hash of the content that has arrived from the copy-source with this value. * * sourceContentMD5 and sourceContentCrc64 cannot be set at same time. - * - * @type {Uint8Array} - * @memberof PageBlobUploadPagesFromURLOptions */ sourceContentMD5?: Uint8Array; /** @@ -5458,16 +4445,10 @@ export interface PageBlobUploadPagesFromURLOptions extends CommonOptions { * When this is specified, the storage service compares the hash of the content that has arrived from the copy-source with this value. * * sourceContentMD5 and sourceContentCrc64 cannot be set at same time. - * - * @type {Uint8Array} - * @memberof PageBlobUploadPagesFromURLOptions */ sourceContentCrc64?: Uint8Array; /** * Customer Provided Key Info. - * - * @type {CpkInfo} - * @memberof PageBlobUploadPagesFromURLOptions */ customerProvidedKey?: CpkInfo; /** @@ -5475,43 +4456,26 @@ export interface PageBlobUploadPagesFromURLOptions extends CommonOptions { * encrypt the data provided in the request. If not specified, encryption is performed with the * default account encryption scope. For more information, see Encryption at Rest for Azure * Storage Services. - * - * @type {string} - * @memberof PageBlobUploadPagesFromURLOptions */ encryptionScope?: string; } /** * Contains response data for the {@link PageBlobClient.createIfNotExists} operation. - * - * @export - * @interface PageBlobCreateIfNotExistsResponse */ export interface PageBlobCreateIfNotExistsResponse extends PageBlobCreateResponse { /** * Indicate whether the blob is successfully created. Is false when the blob is not changed as it already exists. - * - * @type {boolean} - * @memberof PageBlobCreateIfNotExistsResponse */ succeeded: boolean; } /** * PageBlobClient defines a set of operations applicable to page blobs. - * - * @export - * @class PageBlobClient - * @extends {BlobClient} */ export class PageBlobClient extends BlobClient { /** * pageBlobsContext provided by protocol layer. - * - * @private - * @type {PageBlobs} - * @memberof PageBlobClient */ private pageBlobContext: PageBlob; @@ -5528,7 +4492,6 @@ export class PageBlobClient extends BlobClient { * @param containerName - Container name. * @param blobName - Blob name. * @param options - Optional. Options to configure the HTTP pipeline. - * @memberof PageBlobClient */ constructor( connectionString: string, @@ -5545,9 +4508,8 @@ export class PageBlobClient extends BlobClient { * @param url - A Client string pointing to Azure Storage page blob, such as * "https://myaccount.blob.core.windows.net/mycontainer/pageblob". You can append a SAS * if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString". - * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. + * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. * @param options - Optional. Options to configure the HTTP pipeline. - * @memberof PageBlobClient */ constructor( url: string, @@ -5567,7 +4529,6 @@ export class PageBlobClient extends BlobClient { * Such as a blob named "my?blob%", the URL should be "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25". * @param pipeline - Call newPipeline() to create a default * pipeline, or provide a customized pipeline. - * @memberof PageBlobClient */ constructor(url: string, pipeline: Pipeline); constructor( @@ -5661,7 +4622,6 @@ export class PageBlobClient extends BlobClient { * * @param snapshot - The snapshot timestamp. * @returns A new PageBlobClient object identical to the source but with the specified snapshot timestamp. - * @memberof PageBlobClient */ public withSnapshot(snapshot: string): PageBlobClient { return new PageBlobClient( @@ -5682,7 +4642,6 @@ export class PageBlobClient extends BlobClient { * @param size - size of the page blob. * @param options - Options to the Page Blob Create operation. * @returns Response data for the Page Blob Create operation. - * @memberof PageBlobClient */ public async create( size: number, @@ -5727,8 +4686,6 @@ export class PageBlobClient extends BlobClient { * * @param size - size of the page blob. * @param options - - * - * @memberof PageBlobClient */ public async createIfNotExists( size: number, @@ -5782,7 +4739,6 @@ export class PageBlobClient extends BlobClient { * @param count - Content length of the body, also number of bytes to be uploaded * @param options - Options to the Page Blob Upload Pages operation. * @returns Response data for the Page Blob Upload Pages operation. - * @memberof PageBlobClient */ public async uploadPages( body: HttpRequestBody, @@ -5831,8 +4787,6 @@ export class PageBlobClient extends BlobClient { * @param destOffset - Offset of destination page blob * @param count - Number of bytes to be uploaded from source page blob * @param options - - * - * @memberof PageBlobClient */ public async uploadPagesFromURL( sourceURL: string, @@ -5894,7 +4848,6 @@ export class PageBlobClient extends BlobClient { * @param count - Number of bytes to clear. * @param options - Options to the Page Blob Clear Pages operation. * @returns Response data for the Page Blob Clear Pages operation. - * @memberof PageBlobClient */ public async clearPages( offset: number = 0, @@ -5936,7 +4889,6 @@ export class PageBlobClient extends BlobClient { * @param count - Number of bytes to get. * @param options - Options to the Page Blob Get Ranges operation. * @returns Response data for the Page Blob Get Ranges operation. - * @memberof PageBlobClient */ public async getPageRanges( offset: number = 0, @@ -5981,7 +4933,6 @@ export class PageBlobClient extends BlobClient { * @param prevSnapshot - Timestamp of snapshot to retrieve the difference. * @param options - Options to the Page Blob Get Page Ranges Diff operation. * @returns Response data for the Page Blob Get Page Range Diff operation. - * @memberof PageBlobClient */ public async getPageRangesDiff( offset: number, @@ -6029,7 +4980,6 @@ export class PageBlobClient extends BlobClient { * @param prevSnapshotUrl - URL of snapshot to retrieve the difference. * @param options - Options to the Page Blob Get Page Ranges Diff operation. * @returns Response data for the Page Blob Get Page Range Diff operation. - * @memberof PageBlobClient */ public async getPageRangesDiffForManagedDisks( offset: number, @@ -6075,7 +5025,6 @@ export class PageBlobClient extends BlobClient { * @param size - Target size * @param options - Options to the Page Blob Resize operation. * @returns Response data for the Page Blob Resize operation. - * @memberof PageBlobClient */ public async resize( size: number, @@ -6113,7 +5062,6 @@ export class PageBlobClient extends BlobClient { * @param sequenceNumber - Required if sequenceNumberAction is max or update * @param options - Options to the Page Blob Update Sequence Number operation. * @returns Response data for the Page Blob Update Sequence Number operation. - * @memberof PageBlobClient */ public async updateSequenceNumber( sequenceNumberAction: SequenceNumberActionType, @@ -6159,7 +5107,6 @@ export class PageBlobClient extends BlobClient { * https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot= * @param options - Options to the Page Blob Copy Incremental operation. * @returns Response data for the Page Blob Copy Incremental operation. - * @memberof PageBlobClient */ public async startCopyIncremental( copySource: string, diff --git a/sdk/storage/storage-blob/src/ContainerClient.ts b/sdk/storage/storage-blob/src/ContainerClient.ts index 5e2f140d6bec..8173719872bf 100644 --- a/sdk/storage/storage-blob/src/ContainerClient.ts +++ b/sdk/storage/storage-blob/src/ContainerClient.ts @@ -71,185 +71,124 @@ import { BlobBatchClient } from "./BlobBatchClient"; /** * Options to configure {@link ContainerClient.create} operation. - * - * @export - * @interface ContainerCreateOptions */ export interface ContainerCreateOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ContainerCreateOptions */ abortSignal?: AbortSignalLike; /** * A collection of key-value string pair to associate with the container. - * - * @type {Metadata} - * @memberof ContainerCreateOptions */ metadata?: Metadata; /** * Specifies whether data in the container may be accessed publicly and the level of access. Possible values include: * - `container`: Specifies full public read access for container and blob data. Clients can enumerate blobs within the container via anonymous request, but cannot enumerate containers within the storage account. * - `blob`: Specifies public read access for blobs. Blob data within this container can be read via anonymous request, but container data is not available. Clients cannot enumerate blobs within the container via anonymous request. - * - * @type {PublicAccessType} - * @memberof ContainerCreateOptions */ access?: PublicAccessType; /** * Container encryption scope info. - * - * @type {ContainerEncryptionScope} - * @memberof ContainerCreateOptions */ containerEncryptionScope?: ContainerEncryptionScope; } /** * Options to configure {@link ContainerClient.getProperties} operation. - * - * @export - * @interface ContainerGetPropertiesOptions */ export interface ContainerGetPropertiesOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ContainerGetPropertiesOptions */ abortSignal?: AbortSignalLike; /** * If specified, contains the lease id that must be matched and lease with this id * must be active in order for the operation to succeed. - * - * @type {LeaseAccessConditions} - * @memberof ContainerGetPropertiesOptions */ conditions?: LeaseAccessConditions; } /** * Options to configure {@link ContainerClient.delete} operation. - * - * @export - * @interface ContainerDeleteMethodOptions */ export interface ContainerDeleteMethodOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ContainerDeleteMethodOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when deleting the container. - * - * @type {ContainerRequestConditions} - * @memberof ContainerDeleteMethodOptions */ conditions?: ContainerRequestConditions; } /** * Options to configure {@link ContainerClient.exists} operation. - * - * @export - * @interface ContainerExistsOptions */ export interface ContainerExistsOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ContainerDeleteMethodOptions */ abortSignal?: AbortSignalLike; } /** * Options to configure {@link ContainerClient.setMetadata} operation. - * - * @export - * @interface ContainerSetMetadataOptions */ export interface ContainerSetMetadataOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ContainerSetMetadataOptions */ abortSignal?: AbortSignalLike; /** * If specified, contains the lease id that must be matched and lease with this id * must be active in order for the operation to succeed. - * - * @type {ContainerRequestConditions} - * @memberof ContainerSetMetadataOptions */ conditions?: ContainerRequestConditions; } /** * Options to configure {@link ContainerClient.getAccessPolicy} operation. - * - * @export - * @interface ContainerGetAccessPolicyOptions */ export interface ContainerGetAccessPolicyOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ContainerGetAccessPolicyOptions */ abortSignal?: AbortSignalLike; /** * If specified, contains the lease id that must be matched and lease with this id * must be active in order for the operation to succeed. - * - * @type {LeaseAccessConditions} - * @memberof ContainerGetAccessPolicyOptions */ conditions?: LeaseAccessConditions; } /** * Signed identifier. - * - * @export - * @interface SignedIdentifier */ export interface SignedIdentifier { /** - * @member {string} id a unique id + * a unique id */ id: string; /** - * @member {AccessPolicy} accessPolicy */ accessPolicy: { /** - * @member {Date} startsOn Optional. The date-time the policy is active + * Optional. The date-time the policy is active */ startsOn?: Date; /** - * @member {Date} expiresOn Optional. The date-time the policy expires + * Optional. The date-time the policy expires */ expiresOn?: Date; /** - * @member {string} permissions The permissions for the acl policy + * The permissions for the acl policy * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl */ permissions?: string; @@ -283,161 +222,101 @@ export declare type ContainerGetAccessPolicyResponse = { /** * Options to configure {@link ContainerClient.setAccessPolicy} operation. - * - * @export - * @interface ContainerSetAccessPolicyOptions */ export interface ContainerSetAccessPolicyOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ContainerSetAccessPolicyOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when setting the access policy. - * - * @type {ContainerRequestConditions} - * @memberof ContainerSetAccessPolicyOptions */ conditions?: ContainerRequestConditions; } /** * Options to configure Container - Acquire Lease operation. - * - * @export - * @interface ContainerAcquireLeaseOptions */ export interface ContainerAcquireLeaseOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ContainerAcquireLeaseOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when acquiring the lease. - * - * @type {ModifiedAccessConditions} - * @memberof ContainerAcquireLeaseOptions */ conditions?: ModifiedAccessConditions; } /** * Options to configure Container - Release Lease operation. - * - * @export - * @interface ContainerReleaseLeaseOptions */ export interface ContainerReleaseLeaseOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ContainerReleaseLeaseOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when releasing the lease. - * - * @type {ModifiedAccessConditions} - * @memberof ContainerReleaseLeaseOptions */ conditions?: ModifiedAccessConditions; } /** * Options to configure Container - Renew Lease operation. - * - * @export - * @interface ContainerRenewLeaseOptions */ export interface ContainerRenewLeaseOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ContainerRenewLeaseOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when renewing the lease. - * - * @type {ModifiedAccessConditions} - * @memberof ContainerRenewLeaseOptions */ conditions?: ModifiedAccessConditions; } /** * Options to configure Container - Break Lease operation. - * - * @export - * @interface ContainerBreakLeaseOptions */ export interface ContainerBreakLeaseOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ContainerBreakLeaseOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when breaking the lease. - * - * @type {ModifiedAccessConditions} - * @memberof ContainerBreakLeaseOptions */ conditions?: ModifiedAccessConditions; } /** * Options to configure Container - Change Lease operation. - * - * @export - * @interface ContainerChangeLeaseOptions */ export interface ContainerChangeLeaseOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ContainerChangeLeaseOptions */ abortSignal?: AbortSignalLike; /** * Conditions to meet when changing the lease. - * - * @type {ModifiedAccessConditions} - * @memberof ContainerChangeLeaseOptions */ conditions?: ModifiedAccessConditions; } /** * Options to configure the {@link ContainerClient.deleteBlob} operation. - * - * @export - * @interface ContainerDeleteBlobOptions */ export interface ContainerDeleteBlobOptions extends BlobDeleteOptions { /** * An opaque DateTime value that, when present, specifies the version * of the blob to delete. It's for service version 2019-10-10 and newer. - * - * @type {string} - * @memberof ContainerDeleteBlobOptions */ versionId?: string; } @@ -451,16 +330,11 @@ export interface ContainerDeleteBlobOptions extends BlobDeleteOptions { * - {@link ContainerClient.listBlobHierarchySegment} * - {@link ContainerClient.listHierarchySegments} * - {@link ContainerClient.listItemsByHierarchy} - * - * @interface ContainerListBlobsSegmentOptions */ interface ContainerListBlobsSegmentOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ContainerListBlobsSegmentOptions */ abortSignal?: AbortSignalLike; /** @@ -600,17 +474,11 @@ export type ContainerListBlobFlatSegmentResponse = ListBlobsFlatSegmentResponse * See: * - {@link ContainerClient.listBlobsFlat} * - {@link ContainerClient.listBlobsByHierarchy} - * - * @export - * @interface ContainerListBlobsOptions */ export interface ContainerListBlobsOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ContainerListBlobsOptions */ abortSignal?: AbortSignalLike; /** @@ -651,65 +519,40 @@ export interface ContainerListBlobsOptions extends CommonOptions { /** * Contains response data for the {@link ContainerClient.createIfNotExists} operation. - * - * @export - * @interface ContainerCreateIfNotExistsResponse */ export interface ContainerCreateIfNotExistsResponse extends ContainerCreateResponse { /** * Indicate whether the container is successfully created. Is false when the container is not changed as it already exists. - * - * @type {boolean} - * @memberof ContainerCreateIfNotExistsResponse */ succeeded: boolean; } /** * Contains response data for the {@link ContainerClient.deleteIfExists} operation. - * - * @export - * @interface ContainerDeleteIfExistsResponse */ export interface ContainerDeleteIfExistsResponse extends ContainerDeleteResponse { /** * Indicate whether the container is successfully deleted. Is false if the container does not exist in the first place. - * - * @type {boolean} - * @memberof ContainerDeleteIfExistsResponse */ succeeded: boolean; } /** * Options to configure {@link ContainerClient.generateSasUrl} operation. - * - * @export - * @interface ContainerGenerateSasUrlOptions */ export interface ContainerGenerateSasUrlOptions extends CommonGenerateSasUrlOptions { /** * Optional only when identifier is provided. Specifies the list of permissions to be associated with the SAS. - * - * @type {ContainerSASPermissions} - * @memberof ContainerGenerateSasUrlOptions */ permissions?: ContainerSASPermissions; } /** * A ContainerClient represents a URL to the Azure Storage container allowing you to manipulate its blobs. - * - * @export - * @class ContainerClient */ export class ContainerClient extends StorageClient { /** * containerContext provided by protocol layer. - * - * @private - * @type {Containers} - * @memberof ContainerClient */ private containerContext: Container; @@ -733,7 +576,6 @@ export class ContainerClient extends StorageClient { * `BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString` * @param containerName - Container name. * @param options - Optional. Options to configure the HTTP pipeline. - * @memberof ContainerClient */ constructor(connectionString: string, containerName: string, options?: StoragePipelineOptions); /** @@ -746,9 +588,8 @@ export class ContainerClient extends StorageClient { * "https://myaccount.blob.core.windows.net/mycontainer". You can * append a SAS if using AnonymousCredential, such as * "https://myaccount.blob.core.windows.net/mycontainer?sasString". - * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. + * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. * @param options - Optional. Options to configure the HTTP pipeline. - * @memberof ContainerClient */ constructor( url: string, @@ -767,7 +608,6 @@ export class ContainerClient extends StorageClient { * "https://myaccount.blob.core.windows.net/mycontainer?sasString". * @param pipeline - Call newPipeline() to create a default * pipeline, or provide a customized pipeline. - * @memberof ContainerClient */ constructor(url: string, pipeline: Pipeline); constructor( @@ -849,7 +689,6 @@ export class ContainerClient extends StorageClient { * * @param options - Options to Container Create operation. * - * @memberof ContainerClient * * Example usage: * @@ -885,8 +724,6 @@ export class ContainerClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-container * * @param options - - * - * @memberof ContainerClient */ public async createIfNotExists( options: ContainerCreateOptions = {} @@ -936,8 +773,6 @@ export class ContainerClient extends StorageClient { * applications after this function completes. * * @param options - - * - * @memberof ContainerClient */ public async exists(options: ContainerExistsOptions = {}): Promise { const { span, spanOptions } = createSpan("ContainerClient-exists", options.tracingOptions); @@ -970,7 +805,6 @@ export class ContainerClient extends StorageClient { * * @param blobName - A blob name * @returns A new BlobClient object for the given blob name. - * @memberof ContainerClient */ public getBlobClient(blobName: string): BlobClient { return new BlobClient(appendToURLPath(this.url, encodeURIComponent(blobName)), this.pipeline); @@ -980,8 +814,6 @@ export class ContainerClient extends StorageClient { * Creates an {@link AppendBlobClient} * * @param blobName - An append blob name - * - * @memberof ContainerClient */ public getAppendBlobClient(blobName: string): AppendBlobClient { return new AppendBlobClient( @@ -995,7 +827,6 @@ export class ContainerClient extends StorageClient { * * @param blobName - A block blob name * - * @memberof ContainerClient * * Example usage: * @@ -1017,8 +848,6 @@ export class ContainerClient extends StorageClient { * Creates a {@link PageBlobClient} * * @param blobName - A page blob name - * - * @memberof ContainerClient */ public getPageBlobClient(blobName: string): PageBlobClient { return new PageBlobClient( @@ -1038,8 +867,6 @@ export class ContainerClient extends StorageClient { * will retain their original casing. * * @param options - Options to Container Get Properties operation. - * - * @memberof ContainerClient */ public async getProperties( options: ContainerGetPropertiesOptions = {} @@ -1075,8 +902,6 @@ export class ContainerClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container * * @param options - Options to Container Delete operation. - * - * @memberof ContainerClient */ public async delete( options: ContainerDeleteMethodOptions = {} @@ -1110,8 +935,6 @@ export class ContainerClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container * * @param options - Options to Container Delete operation. - * - * @memberof ContainerClient */ public async deleteIfExists( options: ContainerDeleteMethodOptions = {} @@ -1164,8 +987,6 @@ export class ContainerClient extends StorageClient { * @param metadata - Replace existing metadata with this value. * If no value provided the existing metadata will be removed. * @param options - Options to Container Set Metadata operation. - * - * @memberof ContainerClient */ public async setMetadata( metadata?: Metadata, @@ -1212,8 +1033,6 @@ export class ContainerClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl * * @param options - Options to Container Get Access Policy operation. - * - * @memberof ContainerClient */ public async getAccessPolicy( options: ContainerGetAccessPolicyOptions = {} @@ -1297,8 +1116,6 @@ export class ContainerClient extends StorageClient { * @param access - The level of public access to data in the container. * @param containerAcl - Array of elements each having a unique Id and details of the access policy. * @param options - Options to Container Set Access Policy operation. - * - * @memberof ContainerClient */ public async setAccessPolicy( access?: PublicAccessType, @@ -1351,7 +1168,6 @@ export class ContainerClient extends StorageClient { * * @param proposeLeaseId - Initial proposed lease Id. * @returns A new BlobLeaseClient object for managing leases on the container. - * @memberof ContainerClient */ public getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient { return new BlobLeaseClient(this, proposeLeaseId); @@ -1378,7 +1194,6 @@ export class ContainerClient extends StorageClient { * string including non non-Base64/Hex-encoded characters. * @param options - Options to configure the Block Blob Upload operation. * @returns Block Blob upload response data and the corresponding BlockBlobClient instance. - * @memberof ContainerClient */ public async uploadBlockBlob( blobName: string, @@ -1421,7 +1236,6 @@ export class ContainerClient extends StorageClient { * @param blobName - * @param options - Options to Blob Delete operation. * @returns Block blob deletion response data. - * @memberof ContainerClient */ public async deleteBlob( blobName: string, @@ -1457,8 +1271,6 @@ export class ContainerClient extends StorageClient { * * @param marker - A string value that identifies the portion of the list to be returned with the next list operation. * @param options - Options to Container List Blob Flat Segment operation. - * - * @memberof ContainerClient */ private async listBlobFlatSegment( marker?: string, @@ -1513,8 +1325,6 @@ export class ContainerClient extends StorageClient { * @param delimiter - The character or string used to define the virtual hierarchy * @param marker - A string value that identifies the portion of the list to be returned with the next list operation. * @param options - Options to Container List Blob Hierarchy Segment operation. - * - * @memberof ContainerClient */ private async listBlobHierarchySegment( delimiter: string, @@ -1563,7 +1373,6 @@ export class ContainerClient extends StorageClient { /** * Returns an AsyncIterableIterator for ContainerListBlobFlatSegmentResponse * - * @private * @param marker - A string value that identifies the portion of * the list of blobs to be returned with the next listing operation. The * operation returns the ContinuationToken value within the response body if the @@ -1572,8 +1381,6 @@ export class ContainerClient extends StorageClient { * the marker parameter in a subsequent call to request the next page of list * items. The marker value is opaque to the client. * @param options - Options to list blobs operation. - * - * @memberof ContainerClient */ private async *listSegments( marker?: string, @@ -1592,10 +1399,7 @@ export class ContainerClient extends StorageClient { /** * Returns an AsyncIterableIterator of {@link BlobItem} objects * - * @private * @param options - Options to list blobs operation. - * - * @memberof ContainerClient */ private async *listItems( options: ContainerListBlobsSegmentOptions = {} @@ -1675,7 +1479,6 @@ export class ContainerClient extends StorageClient { * * @param options - Options to list blobs. * @returns An asyncIterableIterator that supports paging. - * @memberof ContainerClient */ public listBlobsFlat( options: ContainerListBlobsOptions = {} @@ -1715,19 +1518,19 @@ export class ContainerClient extends StorageClient { const iter = this.listItems(updatedOptions); return { /** - * @member {Promise} [next] The next method, part of the iteration protocol + * The next method, part of the iteration protocol */ next() { return iter.next(); }, /** - * @member {Symbol} [asyncIterator] The connection to the async iterator, part of the iteration protocol + * The connection to the async iterator, part of the iteration protocol */ [Symbol.asyncIterator]() { return this; }, /** - * @member {Function} [byPage] Return an AsyncIterableIterator that works a page at a time + * Return an AsyncIterableIterator that works a page at a time */ byPage: (settings: PageSettings = {}) => { return this.listSegments(settings.continuationToken, { @@ -1741,7 +1544,6 @@ export class ContainerClient extends StorageClient { /** * Returns an AsyncIterableIterator for ContainerListBlobHierarchySegmentResponse * - * @private * @param delimiter - The character or string used to define the virtual hierarchy * @param marker - A string value that identifies the portion of * the list of blobs to be returned with the next listing operation. The @@ -1751,8 +1553,6 @@ export class ContainerClient extends StorageClient { * the marker parameter in a subsequent call to request the next page of list * items. The marker value is opaque to the client. * @param options - Options to list blobs operation. - * - * @memberof ContainerClient */ private async *listHierarchySegments( delimiter: string, @@ -1776,11 +1576,8 @@ export class ContainerClient extends StorageClient { /** * Returns an AsyncIterableIterator for {@link BlobPrefix} and {@link BlobItem} objects. * - * @private * @param delimiter - The character or string used to define the virtual hierarchy * @param options - Options to list blobs operation. - * @returns & BlobItem>} - * @memberof ContainerClient */ private async *listItemsByHierarchy( delimiter: string, @@ -1879,10 +1676,6 @@ export class ContainerClient extends StorageClient { * * @param delimiter - The character or string used to define the virtual hierarchy * @param options - Options to list blobs operation. - * @returns {(PagedAsyncIterableIterator< - * { kind: "prefix" } & BlobPrefix | { kind: "blob" } & BlobItem, - * ContainerListBlobHierarchySegmentResponse>)} - * @memberof ContainerClient */ public listBlobsByHierarchy( delimiter: string, @@ -1929,19 +1722,19 @@ export class ContainerClient extends StorageClient { const iter = this.listItemsByHierarchy(delimiter, updatedOptions); return { /** - * @member {Promise} [next] The next method, part of the iteration protocol + * The next method, part of the iteration protocol */ async next() { return iter.next(); }, /** - * @member {Symbol} [asyncIterator] The connection to the async iterator, part of the iteration protocol + * The connection to the async iterator, part of the iteration protocol */ [Symbol.asyncIterator]() { return this; }, /** - * @member {Function} [byPage] Return an AsyncIterableIterator that works a page at a time + * Return an AsyncIterableIterator that works a page at a time */ byPage: (settings: PageSettings = {}) => { return this.listHierarchySegments(delimiter, settings.continuationToken, { @@ -2002,7 +1795,6 @@ export class ContainerClient extends StorageClient { * * @param options - Optional parameters. * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token. - * @memberof ContainerClient */ public generateSasUrl(options: ContainerGenerateSasUrlOptions): Promise { return new Promise((resolve) => { @@ -2030,7 +1822,6 @@ export class ContainerClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch * * @returns A new BlobBatchClient object for this container. - * @memberof ContainerClient */ public getBlobBatchClient(): BlobBatchClient { return new BlobBatchClient(this.url, this.pipeline); diff --git a/sdk/storage/storage-blob/src/PageBlobRangeResponse.ts b/sdk/storage/storage-blob/src/PageBlobRangeResponse.ts index aaeffcb4605b..cae219869873 100644 --- a/sdk/storage/storage-blob/src/PageBlobRangeResponse.ts +++ b/sdk/storage/storage-blob/src/PageBlobRangeResponse.ts @@ -81,7 +81,7 @@ export interface PageBlobGetPageRangesDiffResponse * Function that converts PageRange and ClearRange to a common Range object. * PageRange and ClearRange have start and end while Range offset and count * this function normalizes to Range. - * @param response Model PageBlob Range response + * @param response - Model PageBlob Range response */ export function rangeResponseFromModel( response: PageBlobGetPageRangesResponseModel | PageBlobGetPageRangesDiffResponseModel diff --git a/sdk/storage/storage-blob/src/Pipeline.ts b/sdk/storage/storage-blob/src/Pipeline.ts index 1e59f48d3423..d3f5541f100e 100644 --- a/sdk/storage/storage-blob/src/Pipeline.ts +++ b/sdk/storage/storage-blob/src/Pipeline.ts @@ -60,16 +60,10 @@ export { /** * Option interface for Pipeline constructor. - * - * @export - * @interface PipelineOptions */ export interface PipelineOptions { /** * Optional. Configures the HTTP client to send requests and receive responses. - * - * @type {IHttpClient} - * @memberof PipelineOptions */ httpClient?: IHttpClient; } @@ -81,23 +75,14 @@ export interface PipelineOptions { * * Refer to {@link newPipeline} and provided policies before implementing your * customized Pipeline. - * - * @export - * @class Pipeline */ export class Pipeline { /** * A list of chained request policy factories. - * - * @type {RequestPolicyFactory[]} - * @memberof Pipeline */ public readonly factories: RequestPolicyFactory[]; /** * Configures pipeline logger and HTTP client. - * - * @type {PipelineOptions} - * @memberof Pipeline */ public readonly options: PipelineOptions; @@ -106,7 +91,6 @@ export class Pipeline { * * @param factories - * @param options - - * @memberof Pipeline */ constructor(factories: RequestPolicyFactory[], options: PipelineOptions = {}) { this.factories = factories; @@ -123,7 +107,6 @@ export class Pipeline { * ServiceClient constructor. * * @returns The ServiceClientOptions object from this Pipeline. - * @memberof Pipeline */ public toServiceClientOptions(): ServiceClientOptions { return { @@ -135,9 +118,6 @@ export class Pipeline { /** * Options interface for the {@link newPipeline} function. - * - * @export - * @interface StoragePipelineOptions */ export interface StoragePipelineOptions { /** @@ -146,31 +126,19 @@ export interface StoragePipelineOptions { proxyOptions?: ProxyOptions; /** * Options for adding user agent details to outgoing requests. - * - * @type {UserAgentOptions} - * @memberof StoragePipelineOptions */ userAgentOptions?: UserAgentOptions; /** * Configures the built-in retry policy behavior. - * - * @type {StorageRetryOptions} - * @memberof StoragePipelineOptions */ retryOptions?: StorageRetryOptions; /** * Keep alive configurations. Default keep-alive is enabled. - * - * @type {KeepAliveOptions} - * @memberof StoragePipelineOptions */ keepAliveOptions?: KeepAliveOptions; /** * Configures the HTTP client to send requests and receive responses. - * - * @type {IHttpClient} - * @memberof StoragePipelineOptions */ httpClient?: IHttpClient; } @@ -178,8 +146,7 @@ export interface StoragePipelineOptions { /** * Creates a new Pipeline object with Credential provided. * - * @export - * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. + * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. * @param pipelineOptions - Optional. Options. * @returns A new Pipeline object. */ diff --git a/sdk/storage/storage-blob/src/Range.ts b/sdk/storage/storage-blob/src/Range.ts index a6161b54124f..3d133f871466 100644 --- a/sdk/storage/storage-blob/src/Range.ts +++ b/sdk/storage/storage-blob/src/Range.ts @@ -5,24 +5,15 @@ /** * Range for Blob Service Operations. * @see https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-blob-service-operations - * - * @export - * @interface Range */ export interface Range { /** * StartByte, larger than or equal 0. - * - * @type {string} - * @memberof Range */ offset: number; /** * Optional. Count of bytes, larger than 0. * If not provided, will return bytes from offset to the end. - * - * @type {string} - * @memberof Range */ count?: number; } @@ -32,9 +23,7 @@ export interface Range { * * "bytes=255-" or "bytes=0-511" * - * @export * @param iRange - - * */ export function rangeToString(iRange: Range): string { if (iRange.offset < 0) { diff --git a/sdk/storage/storage-blob/src/StorageBrowserPolicyFactory.ts b/sdk/storage/storage-blob/src/StorageBrowserPolicyFactory.ts index 0fa7ac675b09..9a7c4b614ced 100644 --- a/sdk/storage/storage-blob/src/StorageBrowserPolicyFactory.ts +++ b/sdk/storage/storage-blob/src/StorageBrowserPolicyFactory.ts @@ -7,10 +7,6 @@ export { StorageBrowserPolicy }; /** * StorageBrowserPolicyFactory is a factory class helping generating StorageBrowserPolicy objects. - * - * @export - * @class StorageBrowserPolicyFactory - * @implements {RequestPolicyFactory} */ export class StorageBrowserPolicyFactory implements RequestPolicyFactory { /** @@ -18,8 +14,6 @@ export class StorageBrowserPolicyFactory implements RequestPolicyFactory { * * @param nextPolicy - * @param options - - * - * @memberof StorageBrowserPolicyFactory */ public create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageBrowserPolicy { return new StorageBrowserPolicy(nextPolicy, options); diff --git a/sdk/storage/storage-blob/src/StorageClient.ts b/sdk/storage/storage-blob/src/StorageClient.ts index 4bed1e15f95f..5c361869383d 100644 --- a/sdk/storage/storage-blob/src/StorageClient.ts +++ b/sdk/storage/storage-blob/src/StorageClient.ts @@ -22,16 +22,10 @@ export interface CommonOptions { /** * A StorageClient represents a based URL class for {@link BlobServiceClient}, {@link ContainerClient} * and etc. - * - * @export - * @class StorageClient */ export abstract class StorageClient { /** * Encoded URL string value. - * - * @type {string} - * @memberof StorageClient */ public readonly url: string; public readonly accountName: string; @@ -39,31 +33,18 @@ export abstract class StorageClient { * Request policy pipeline. * * @internal - * @hidden - * @type {Pipeline} - * @memberof StorageClient */ protected readonly pipeline: Pipeline; /** - * Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. - * - * @type {StorageSharedKeyCredential | AnonymousCredential | TokenCredential} - * @memberof StorageClient + * Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. */ public readonly credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential; /** * StorageClient is a reference to protocol layer operations entry, which is * generated by AutoRest generator. - * - * @protected - * @type {StorageClientContext} - * @memberof StorageClient */ protected readonly storageClientContext: StorageClientContext; /** - * @protected - * @type {boolean} - * @memberof StorageClient */ protected readonly isHttps: boolean; @@ -71,7 +52,6 @@ export abstract class StorageClient { * Creates an instance of StorageClient. * @param url - url to resource * @param pipeline - request policy pipeline. - * @memberof StorageClient */ protected constructor(url: string, pipeline: Pipeline) { // URL should be encoded and only once, protocol layer shouldn't encode URL again diff --git a/sdk/storage/storage-blob/src/StorageRetryPolicyFactory.ts b/sdk/storage/storage-blob/src/StorageRetryPolicyFactory.ts index 4ab544371756..fbd217bf7048 100644 --- a/sdk/storage/storage-blob/src/StorageRetryPolicyFactory.ts +++ b/sdk/storage/storage-blob/src/StorageRetryPolicyFactory.ts @@ -8,16 +8,10 @@ export { StorageRetryPolicyType, StorageRetryPolicy }; /** * Storage Blob retry options interface. - * - * @export - * @interface StorageRetryOptions */ export interface StorageRetryOptions { /** * Optional. StorageRetryPolicyType, default is exponential retry policy. - * - * @type {StorageRetryPolicyType} - * @memberof StorageRetryOptions */ readonly retryPolicyType?: StorageRetryPolicyType; @@ -25,9 +19,6 @@ export interface StorageRetryOptions { * Optional. Max try number of attempts, default is 4. * A value of 1 means 1 try and no retries. * A value smaller than 1 means default retry number of attempts. - * - * @type {number} - * @memberof StorageRetryOptions */ readonly maxTries?: number; @@ -37,9 +28,6 @@ export interface StorageRetryOptions { * Storage server's default timeout policy will be used. * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-blob-service-operations - * - * @type {number} - * @memberof StorageRetryOptions */ readonly tryTimeoutInMs?: number; @@ -47,18 +35,12 @@ export interface StorageRetryOptions { * Optional. Specifies the amount of delay to use before retrying an operation (default is 4s or 4 * 1000ms). * The delay increases (exponentially or linearly) with each retry up to a maximum specified by * maxRetryDelayInMs. If you specify 0, then you must also specify 0 for maxRetryDelayInMs. - * - * @type {number} - * @memberof StorageRetryOptions */ readonly retryDelayInMs?: number; /** * Optional. Specifies the maximum delay allowed before retrying an operation (default is 120s or 120 * 1000ms). * If you specify 0, then you must also specify 0 for retryDelayInMs. - * - * @type {number} - * @memberof StorageRetryOptions */ readonly maxRetryDelayInMs?: number; @@ -69,19 +51,12 @@ export interface StorageRetryOptions { * NOTE: Before setting this field, make sure you understand the issues around * reading stale and potentially-inconsistent data at * {@link https://docs.microsoft.com/en-us/azure/storage/common/storage-designing-ha-apps-with-ragrs} - * - * @type {string} - * @memberof StorageRetryOptions */ readonly secondaryHost?: string; } /** * StorageRetryPolicyFactory is a factory class helping generating {@link StorageRetryPolicy} objects. - * - * @export - * @class StorageRetryPolicyFactory - * @implements {RequestPolicyFactory} */ export class StorageRetryPolicyFactory implements RequestPolicyFactory { private retryOptions?: StorageRetryOptions; @@ -89,7 +64,6 @@ export class StorageRetryPolicyFactory implements RequestPolicyFactory { /** * Creates an instance of StorageRetryPolicyFactory. * @param retryOptions - - * @memberof StorageRetryPolicyFactory */ constructor(retryOptions?: StorageRetryOptions) { this.retryOptions = retryOptions; @@ -100,8 +74,6 @@ export class StorageRetryPolicyFactory implements RequestPolicyFactory { * * @param nextPolicy - * @param options - - * - * @memberof StorageRetryPolicyFactory */ public create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageRetryPolicy { return new StorageRetryPolicy(nextPolicy, options, this.retryOptions); diff --git a/sdk/storage/storage-blob/src/TelemetryPolicyFactory.ts b/sdk/storage/storage-blob/src/TelemetryPolicyFactory.ts index 60b232117747..bb54d80feb88 100644 --- a/sdk/storage/storage-blob/src/TelemetryPolicyFactory.ts +++ b/sdk/storage/storage-blob/src/TelemetryPolicyFactory.ts @@ -15,22 +15,16 @@ import { SDK_VERSION } from "./utils/constants"; /** * TelemetryPolicyFactory is a factory class helping generating {@link TelemetryPolicy} objects. - * - * @export - * @class TelemetryPolicyFactory - * @implements {RequestPolicyFactory} */ export class TelemetryPolicyFactory implements RequestPolicyFactory { /** * @internal - * @hidden */ public readonly telemetryString: string; /** * Creates an instance of TelemetryPolicyFactory. * @param telemetry - - * @memberof TelemetryPolicyFactory */ constructor(telemetry?: UserAgentOptions) { const userAgentInfo: string[] = []; @@ -64,8 +58,6 @@ export class TelemetryPolicyFactory implements RequestPolicyFactory { * * @param nextPolicy - * @param options - - * - * @memberof TelemetryPolicyFactory */ public create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): TelemetryPolicy { return new TelemetryPolicy(nextPolicy, options, this.telemetryString); diff --git a/sdk/storage/storage-blob/src/credentials/AnonymousCredential.ts b/sdk/storage/storage-blob/src/credentials/AnonymousCredential.ts index ae6ac041bb2e..c648c39b932b 100644 --- a/sdk/storage/storage-blob/src/credentials/AnonymousCredential.ts +++ b/sdk/storage/storage-blob/src/credentials/AnonymousCredential.ts @@ -11,10 +11,6 @@ import { Credential } from "./Credential"; * AnonymousCredentialPolicy objects. AnonymousCredentialPolicy is used with * HTTP(S) requests that read public resources or for use with Shared Access * Signatures (SAS). - * - * @export - * @class AnonymousCredential - * @extends {Credential} */ export class AnonymousCredential extends Credential { /** @@ -22,8 +18,6 @@ export class AnonymousCredential extends Credential { * * @param nextPolicy - * @param options - - * - * @memberof AnonymousCredential */ public create( nextPolicy: RequestPolicy, diff --git a/sdk/storage/storage-blob/src/credentials/Credential.ts b/sdk/storage/storage-blob/src/credentials/Credential.ts index 8cc556d37638..ec1bee135c2c 100644 --- a/sdk/storage/storage-blob/src/credentials/Credential.ts +++ b/sdk/storage/storage-blob/src/credentials/Credential.ts @@ -7,10 +7,6 @@ import { CredentialPolicy } from "../policies/CredentialPolicy"; /** * Credential is an abstract class for Azure Storage HTTP requests signing. This * class will host an credentialPolicyCreator factory which generates CredentialPolicy. - * - * @export - * @abstract - * @class Credential */ export abstract class Credential implements RequestPolicyFactory { /** @@ -18,8 +14,6 @@ export abstract class Credential implements RequestPolicyFactory { * * @param _nextPolicy - * @param _options - - * - * @memberof Credential */ public create( // tslint:disable-next-line:variable-name diff --git a/sdk/storage/storage-blob/src/credentials/StorageSharedKeyCredential.ts b/sdk/storage/storage-blob/src/credentials/StorageSharedKeyCredential.ts index 30c8d3bb1426..7e4ceab82cc5 100644 --- a/sdk/storage/storage-blob/src/credentials/StorageSharedKeyCredential.ts +++ b/sdk/storage/storage-blob/src/credentials/StorageSharedKeyCredential.ts @@ -11,25 +11,15 @@ import { Credential } from "./Credential"; * ONLY AVAILABLE IN NODE.JS RUNTIME. * * StorageSharedKeyCredential for account key authorization of Azure Storage service. - * - * @export - * @class StorageSharedKeyCredential - * @extends {Credential} */ export class StorageSharedKeyCredential extends Credential { /** * Azure Storage account name; readonly. - * - * @type {string} - * @memberof StorageSharedKeyCredential */ public readonly accountName: string; /** * Azure Storage account key; readonly. - * - * @type {Buffer} - * @memberof StorageSharedKeyCredential */ private readonly accountKey: Buffer; @@ -37,7 +27,6 @@ export class StorageSharedKeyCredential extends Credential { * Creates an instance of StorageSharedKeyCredential. * @param accountName - * @param accountKey - - * @memberof StorageSharedKeyCredential */ constructor(accountName: string, accountKey: string) { super(); @@ -50,8 +39,6 @@ export class StorageSharedKeyCredential extends Credential { * * @param nextPolicy - * @param options - - * - * @memberof StorageSharedKeyCredential */ public create( nextPolicy: RequestPolicy, @@ -64,8 +51,6 @@ export class StorageSharedKeyCredential extends Credential { * Generates a hash signature for an HTTP request or for a SAS. * * @param stringToSign - - * - * @memberof StorageSharedKeyCredential */ public computeHMACSHA256(stringToSign: string): string { return createHmac("sha256", this.accountKey) diff --git a/sdk/storage/storage-blob/src/credentials/UserDelegationKeyCredential.ts b/sdk/storage/storage-blob/src/credentials/UserDelegationKeyCredential.ts index ba2a80836ee6..7617c1ac79d9 100644 --- a/sdk/storage/storage-blob/src/credentials/UserDelegationKeyCredential.ts +++ b/sdk/storage/storage-blob/src/credentials/UserDelegationKeyCredential.ts @@ -9,33 +9,20 @@ import { UserDelegationKey } from "../BlobServiceClient"; * * UserDelegationKeyCredential is only used for generation of user delegation SAS. * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-user-delegation-sas - * - * @export - * @class UserDelegationKeyCredential */ export class UserDelegationKeyCredential { /** * Azure Storage account name; readonly. - * - * @type {string} - * @memberof UserDelegationKeyCredential */ public readonly accountName: string; /** * Azure Storage user delegation key; readonly. - * - * @type {UserDelegationKey} - * @memberof UserDelegationKeyCredential */ public readonly userDelegationKey: UserDelegationKey; /** * Key value in Buffer type. - * - * @private - * @type {Buffer} - * @memberof UserDelegationKeyCredential */ private readonly key: Buffer; @@ -43,7 +30,6 @@ export class UserDelegationKeyCredential { * Creates an instance of UserDelegationKeyCredential. * @param accountName - * @param userDelegationKey - - * @memberof UserDelegationKeyCredential */ constructor(accountName: string, userDelegationKey: UserDelegationKey) { this.accountName = accountName; @@ -55,8 +41,6 @@ export class UserDelegationKeyCredential { * Generates a hash signature for an HTTP request or for a SAS. * * @param stringToSign - - * - * @memberof UserDelegationKeyCredential */ public computeHMACSHA256(stringToSign: string): string { // console.log(`stringToSign: ${JSON.stringify(stringToSign)}`); diff --git a/sdk/storage/storage-blob/src/log.ts b/sdk/storage/storage-blob/src/log.ts index 139ccf516e70..9cd3da596c2b 100644 --- a/sdk/storage/storage-blob/src/log.ts +++ b/sdk/storage/storage-blob/src/log.ts @@ -4,6 +4,6 @@ import { createClientLogger } from "@azure/logger"; /** - * The @azure/logger configuration for this package. + * The `@azure/logger` configuration for this package. */ export const logger = createClientLogger("storage-blob"); diff --git a/sdk/storage/storage-blob/src/models.ts b/sdk/storage/storage-blob/src/models.ts index b9d06518deca..ad0c565651e1 100644 --- a/sdk/storage/storage-blob/src/models.ts +++ b/sdk/storage/storage-blob/src/models.ts @@ -203,17 +203,11 @@ export type ObjectReplicationStatus = "complete" | "failed"; export interface ObjectReplicationRule { /** * The Object Replication Rule ID. - * - * @type {string} - * @memberof ObjectReplicationRule */ ruleId: string; /** * The Replication Status - * - * @type {ObjectReplicationStatus} - * @memberof ObjectReplicationRule */ replicationStatus: ObjectReplicationStatus; } @@ -223,48 +217,30 @@ export interface ObjectReplicationRule { * This is used when retrieving the Object Replication Properties on the source blob. The policy id for the * destination blob is set in ObjectReplicationDestinationPolicyId of the respective method responses * (e.g. {@link BlobProperties.ObjectReplicationDestinationPolicyId}. - * - * @export - * @interface ObjectReplicationPolicy */ export interface ObjectReplicationPolicy { /** * The Object Replication Policy ID. - * - * @type {string} - * @memberof ObjectReplicationPolicy */ policyId: string; /** * The Rule ID(s) and respective Replication Status(s) that are under the Policy ID. - * - * @type {ObjectReplicationRule[]} - * @memberof ObjectReplicationPolicy */ rules: ObjectReplicationRule[]; } /** * Contains response data for the {@link BlobClient.download} operation. - * - * @export - * @interface BlobDownloadResponseParsed */ export interface BlobDownloadResponseParsed extends BlobDownloadResponseModel { /** * Parsed Object Replication Policy Id, Rule Id(s) and status of the source blob. - * - * @type {ObjectReplicationPolicy[]} - * @memberof BlobDownloadResponseParsed */ objectReplicationSourceProperties?: ObjectReplicationPolicy[]; /** * Object Replication Policy Id of the destination blob. - * - * @type {string} - * @memberof BlobDownloadResponseParsed */ objectReplicationDestinationPolicyId?: string; } @@ -282,40 +258,25 @@ export type BlobQueryArrowFieldType = /** * Describe a field in {@link BlobQueryArrowConfiguration}. - * - * @export - * @interface BlobQueryArrowField */ export interface BlobQueryArrowField { /** * The type of the field. - * - * @type {BlobQueryArrowFieldType} - * @memberof BlobQueryArrowField */ type: BlobQueryArrowFieldType; /** * The name of the field. - * - * @type {string} - * @memberof BlobQueryArrowField */ name?: string; /** * The precision of the field. Required if type is "decimal". - * - * @type {number} - * @memberof BlobQueryArrowField */ precision?: number; /** * The scale of the field. Required if type is is "decimal". - * - * @type {number} - * @memberof BlobQueryArrowField */ scale?: number; } diff --git a/sdk/storage/storage-blob/src/policies/AnonymousCredentialPolicy.ts b/sdk/storage/storage-blob/src/policies/AnonymousCredentialPolicy.ts index 743528139e91..08e4118ad4c0 100644 --- a/sdk/storage/storage-blob/src/policies/AnonymousCredentialPolicy.ts +++ b/sdk/storage/storage-blob/src/policies/AnonymousCredentialPolicy.ts @@ -8,17 +8,12 @@ import { CredentialPolicy } from "./CredentialPolicy"; /** * AnonymousCredentialPolicy is used with HTTP(S) requests that read public resources * or for use with Shared Access Signatures (SAS). - * - * @export - * @class AnonymousCredentialPolicy - * @extends {CredentialPolicy} */ export class AnonymousCredentialPolicy extends CredentialPolicy { /** * Creates an instance of AnonymousCredentialPolicy. * @param nextPolicy - * @param options - - * @memberof AnonymousCredentialPolicy */ constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions) { super(nextPolicy, options); diff --git a/sdk/storage/storage-blob/src/policies/CredentialPolicy.ts b/sdk/storage/storage-blob/src/policies/CredentialPolicy.ts index e8796c296e71..a0866f5705f3 100644 --- a/sdk/storage/storage-blob/src/policies/CredentialPolicy.ts +++ b/sdk/storage/storage-blob/src/policies/CredentialPolicy.ts @@ -6,19 +6,12 @@ import { BaseRequestPolicy, HttpOperationResponse, WebResource } from "@azure/co /** * Credential policy used to sign HTTP(S) requests before sending. This is an * abstract class. - * - * @export - * @abstract - * @class CredentialPolicy - * @extends {BaseRequestPolicy} */ export abstract class CredentialPolicy extends BaseRequestPolicy { /** * Sends out request. * * @param request - - * - * @memberof CredentialPolicy */ public sendRequest(request: WebResource): Promise { return this._nextPolicy.sendRequest(this.signRequest(request)); @@ -28,11 +21,7 @@ export abstract class CredentialPolicy extends BaseRequestPolicy { * Child classes must implement this method with request signing. This method * will be executed in {@link sendRequest}. * - * @protected - * @abstract * @param request - - * - * @memberof CredentialPolicy */ protected signRequest(request: WebResource): WebResource { // Child classes must override this method with request signing. This method diff --git a/sdk/storage/storage-blob/src/policies/StorageBrowserPolicy.ts b/sdk/storage/storage-blob/src/policies/StorageBrowserPolicy.ts index 5e26f9d13903..35748194822e 100644 --- a/sdk/storage/storage-blob/src/policies/StorageBrowserPolicy.ts +++ b/sdk/storage/storage-blob/src/policies/StorageBrowserPolicy.ts @@ -23,16 +23,12 @@ import { setURLParameter } from "../utils/utils.common"; * 2. Remove cookie header for security * * 3. Remove content-length header to avoid browsers warning - * - * @class StorageBrowserPolicy - * @extends {BaseRequestPolicy} */ export class StorageBrowserPolicy extends BaseRequestPolicy { /** * Creates an instance of StorageBrowserPolicy. * @param nextPolicy - * @param options - - * @memberof StorageBrowserPolicy */ constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions) { super(nextPolicy, options); @@ -42,8 +38,6 @@ export class StorageBrowserPolicy extends BaseRequestPolicy { * Sends out request. * * @param request - - * - * @memberof StorageBrowserPolicy */ public async sendRequest(request: WebResource): Promise { if (isNode) { diff --git a/sdk/storage/storage-blob/src/policies/StorageRetryPolicy.ts b/sdk/storage/storage-blob/src/policies/StorageRetryPolicy.ts index b7f0233d1391..a37c34629ddc 100644 --- a/sdk/storage/storage-blob/src/policies/StorageRetryPolicy.ts +++ b/sdk/storage/storage-blob/src/policies/StorageRetryPolicy.ts @@ -22,7 +22,6 @@ import { logger } from "../log"; /** * A factory method used to generated a RetryPolicy factory. * - * @export * @param retryOptions - */ export function NewRetryPolicyFactory(retryOptions?: StorageRetryOptions): RequestPolicyFactory { @@ -35,9 +34,6 @@ export function NewRetryPolicyFactory(retryOptions?: StorageRetryOptions): Reque /** * RetryPolicy types. - * - * @export - * @enum {number} */ export enum StorageRetryPolicyType { /** @@ -64,17 +60,10 @@ const RETRY_ABORT_ERROR = new AbortError("The operation was aborted."); /** * Retry policy with exponential retry and linear retry implemented. - * - * @class RetryPolicy - * @extends {BaseRequestPolicy} */ export class StorageRetryPolicy extends BaseRequestPolicy { /** * RetryOptions. - * - * @private - * @type {StorageRetryOptions} - * @memberof StorageRetryPolicy */ private readonly retryOptions: StorageRetryOptions; @@ -84,7 +73,6 @@ export class StorageRetryPolicy extends BaseRequestPolicy { * @param nextPolicy - * @param options - * @param retryOptions - - * @memberof StorageRetryPolicy */ constructor( nextPolicy: RequestPolicy, @@ -134,8 +122,6 @@ export class StorageRetryPolicy extends BaseRequestPolicy { * Sends request. * * @param request - - * - * @memberof StorageRetryPolicy */ public async sendRequest(request: WebResource): Promise { return this.attemptSendRequest(request, false, 1); @@ -144,15 +130,12 @@ export class StorageRetryPolicy extends BaseRequestPolicy { /** * Decide and perform next retry. Won't mutate request parameter. * - * @protected * @param request - * @param secondaryHas404 - If attempt was against the secondary & it returned a StatusNotFound (404), then * the resource was not found. This may be due to replication delay. So, in this * case, we'll never try the secondary again for this operation. * @param attempt - How many retries has been attempted to performed, starting from 1, which includes * the attempt will be performed by this method call. - * - * @memberof StorageRetryPolicy */ protected async attemptSendRequest( request: WebResource, @@ -203,13 +186,10 @@ export class StorageRetryPolicy extends BaseRequestPolicy { /** * Decide whether to retry according to last HTTP response and retry counters. * - * @protected * @param isPrimaryRetry - * @param attempt - * @param response - * @param err - - * - * @memberof StorageRetryPolicy */ protected shouldRetry( isPrimaryRetry: boolean, @@ -281,11 +261,9 @@ export class StorageRetryPolicy extends BaseRequestPolicy { /** * Delay a calculated time between retries. * - * @private * @param isPrimaryRetry - * @param attempt - * @param abortSignal - - * @memberof StorageRetryPolicy */ private async delay(isPrimaryRetry: boolean, attempt: number, abortSignal?: AbortSignalLike) { let delayTimeInMs: number = 0; diff --git a/sdk/storage/storage-blob/src/policies/StorageSharedKeyCredentialPolicy.ts b/sdk/storage/storage-blob/src/policies/StorageSharedKeyCredentialPolicy.ts index 5a0ddd4116b1..d17572d6715d 100644 --- a/sdk/storage/storage-blob/src/policies/StorageSharedKeyCredentialPolicy.ts +++ b/sdk/storage/storage-blob/src/policies/StorageSharedKeyCredentialPolicy.ts @@ -9,17 +9,10 @@ import { CredentialPolicy } from "./CredentialPolicy"; /** * StorageSharedKeyCredentialPolicy is a policy used to sign HTTP request with a shared key. - * - * @export - * @class StorageSharedKeyCredentialPolicy - * @extends {CredentialPolicy} */ export class StorageSharedKeyCredentialPolicy extends CredentialPolicy { /** * Reference to StorageSharedKeyCredential which generates StorageSharedKeyCredentialPolicy - * - * @type {StorageSharedKeyCredential} - * @memberof StorageSharedKeyCredentialPolicy */ private readonly factory: StorageSharedKeyCredential; @@ -28,7 +21,6 @@ export class StorageSharedKeyCredentialPolicy extends CredentialPolicy { * @param nextPolicy - * @param options - * @param factory - - * @memberof StorageSharedKeyCredentialPolicy */ constructor( nextPolicy: RequestPolicy, @@ -42,10 +34,7 @@ export class StorageSharedKeyCredentialPolicy extends CredentialPolicy { /** * Signs request. * - * @protected * @param request - - * - * @memberof StorageSharedKeyCredentialPolicy */ protected signRequest(request: WebResource): WebResource { request.headers.set(HeaderConstants.X_MS_DATE, new Date().toUTCString()); @@ -90,11 +79,8 @@ export class StorageSharedKeyCredentialPolicy extends CredentialPolicy { * Retrieve header value according to shared key sign rules. * @see https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key * - * @private * @param request - * @param headerName - - * - * @memberof StorageSharedKeyCredentialPolicy */ private getHeaderValueToSign(request: WebResource, headerName: string): string { const value = request.headers.get(headerName); @@ -124,10 +110,7 @@ export class StorageSharedKeyCredentialPolicy extends CredentialPolicy { * 6. Finally, append a new-line character to each canonicalized header in the resulting list. * Construct the CanonicalizedHeaders string by concatenating all headers in this list into a single string. * - * @private * @param request - - * - * @memberof StorageSharedKeyCredentialPolicy */ private getCanonicalizedHeadersString(request: WebResource): string { let headersArray = request.headers.headersArray().filter((value) => { @@ -159,10 +142,7 @@ export class StorageSharedKeyCredentialPolicy extends CredentialPolicy { /** * Retrieves the webResource canonicalized resource string. * - * @private * @param request - - * - * @memberof StorageSharedKeyCredentialPolicy */ private getCanonicalizedResourceString(request: WebResource): string { const path = getURLPath(request.url) || "/"; diff --git a/sdk/storage/storage-blob/src/policies/TelemetryPolicy.ts b/sdk/storage/storage-blob/src/policies/TelemetryPolicy.ts index 519397076b4e..8ec37fecc2c7 100644 --- a/sdk/storage/storage-blob/src/policies/TelemetryPolicy.ts +++ b/sdk/storage/storage-blob/src/policies/TelemetryPolicy.ts @@ -15,16 +15,10 @@ import { HeaderConstants } from "../utils/constants"; /** * TelemetryPolicy is a policy used to tag user-agent header for every requests. - * - * @class TelemetryPolicy - * @extends {BaseRequestPolicy} */ export class TelemetryPolicy extends BaseRequestPolicy { /** * Telemetry string. - * - * @type {string} - * @memberof TelemetryPolicy */ public readonly telemetry: string; @@ -33,7 +27,6 @@ export class TelemetryPolicy extends BaseRequestPolicy { * @param nextPolicy - * @param options - * @param telemetry - - * @memberof TelemetryPolicy */ constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, telemetry: string) { super(nextPolicy, options); @@ -44,8 +37,6 @@ export class TelemetryPolicy extends BaseRequestPolicy { * Sends out request. * * @param request - - * - * @memberof TelemetryPolicy */ public async sendRequest(request: WebResource): Promise { if (isNode) { diff --git a/sdk/storage/storage-blob/src/sas/AccountSASPermissions.ts b/sdk/storage/storage-blob/src/sas/AccountSASPermissions.ts index acdc0f144c68..fa6800b34764 100644 --- a/sdk/storage/storage-blob/src/sas/AccountSASPermissions.ts +++ b/sdk/storage/storage-blob/src/sas/AccountSASPermissions.ts @@ -9,18 +9,12 @@ * values are set, this should be serialized with toString and set as the permissions field on an * {@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 - * @class AccountSASPermissions */ export class AccountSASPermissions { /** * Parse initializes the AccountSASPermissions fields from a string. * - * @static * @param permissions - - * - * @memberof AccountSASPermissions */ public static parse(permissions: string): AccountSASPermissions { const accountSASPermissions = new AccountSASPermissions(); @@ -72,10 +66,7 @@ export class AccountSASPermissions { * Creates a {@link AccountSASPermissions} from a raw object which contains same keys as it * and boolean values for them. * - * @static * @param permissionLike - - * - * @memberof AccountSASPermissions */ public static from(permissionLike: AccountSASPermissionsLike): AccountSASPermissions { const accountSASPermissions = new AccountSASPermissions(); @@ -117,89 +108,56 @@ export class AccountSASPermissions { /** * Permission to read resources and list queues and tables granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public read: boolean = false; /** * Permission to write resources granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public write: boolean = false; /** * Permission to create blobs and files granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public delete: boolean = false; /** * Permission to delete versions granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public deleteVersion: boolean = false; /** * Permission to list blob containers, blobs, shares, directories, and files granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public list: boolean = false; /** * Permission to add messages, table entities, and append to blobs granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public add: boolean = false; /** * Permission to create blobs and files granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public create: boolean = false; /** * Permissions to update messages and table entities granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public update: boolean = false; /** * Permission to get and delete messages granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public process: boolean = false; /** * Specfies Tag access granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public tag: boolean = false; /** * Permission to filter blobs. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public filter: boolean = false; @@ -212,8 +170,6 @@ export class AccountSASPermissions { * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas * - * - * @memberof AccountSASPermissions */ public toString(): string { // The order of the characters should be as specified here to ensure correctness: @@ -264,89 +220,56 @@ export class AccountSASPermissions { export interface AccountSASPermissionsLike { /** * Permission to read resources and list queues and tables granted. - * - * @type {boolean} - * @memberof AccountSASPermissionsLike */ read?: boolean; /** * Permission to write resources granted. - * - * @type {boolean} - * @memberof AccountSASPermissionsLike */ write?: boolean; /** * Permission to create blobs and files granted. - * - * @type {boolean} - * @memberof AccountSASPermissionsLike */ delete?: boolean; /** * Permission to delete versions granted. - * - * @type {boolean} - * @memberof AccountSASPermissionsLike */ deleteVersion?: boolean; /** * Permission to list blob containers, blobs, shares, directories, and files granted. - * - * @type {boolean} - * @memberof AccountSASPermissionsLike */ list?: boolean; /** * Permission to add messages, table entities, and append to blobs granted. - * - * @type {boolean} - * @memberof AccountSASPermissionsLike */ add?: boolean; /** * Permission to create blobs and files granted. - * - * @type {boolean} - * @memberof AccountSASPermissionsLike */ create?: boolean; /** * Permissions to update messages and table entities granted. - * - * @type {boolean} - * @memberof AccountSASPermissionsLike */ update?: boolean; /** * Permission to get and delete messages granted. - * - * @type {boolean} - * @memberof AccountSASPermissionsLike */ process?: boolean; /** * Specfies Tag access granted. - * - * @type {boolean} - * @memberof AccountSASPermissionsLike */ tag?: boolean; /** * Permission to filter blobs. - * - * @type {boolean} - * @memberof AccountSASPermissionsLike */ filter?: boolean; } diff --git a/sdk/storage/storage-blob/src/sas/AccountSASResourceTypes.ts b/sdk/storage/storage-blob/src/sas/AccountSASResourceTypes.ts index ef9073af98be..05d984b8da05 100644 --- a/sdk/storage/storage-blob/src/sas/AccountSASResourceTypes.ts +++ b/sdk/storage/storage-blob/src/sas/AccountSASResourceTypes.ts @@ -9,19 +9,13 @@ * values are set, this should be serialized with toString and set as the resources field on an * {@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 - * @class AccountSASResourceTypes */ export class AccountSASResourceTypes { /** * Creates an {@link AccountSASResourceTypes} from the specified resource types string. This method will throw an * Error if it encounters a character that does not correspond to a valid resource type. * - * @static * @param resourceTypes - - * - * @memberof AccountSASResourceTypes */ public static parse(resourceTypes: string): AccountSASResourceTypes { const accountSASResourceTypes = new AccountSASResourceTypes(); @@ -47,25 +41,16 @@ export class AccountSASResourceTypes { /** * Permission to access service level APIs granted. - * - * @type {boolean} - * @memberof AccountSASResourceTypes */ public service: boolean = false; /** * Permission to access container level APIs (Blob Containers, Tables, Queues, File Shares) granted. - * - * @type {boolean} - * @memberof AccountSASResourceTypes */ public container: boolean = false; /** * Permission to access object level APIs (Blobs, Table Entities, Queue Messages, Files) granted. - * - * @type {boolean} - * @memberof AccountSASResourceTypes */ public object: boolean = false; @@ -74,8 +59,6 @@ export class AccountSASResourceTypes { * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas * - * - * @memberof AccountSASResourceTypes */ public toString(): string { const resourceTypes: string[] = []; diff --git a/sdk/storage/storage-blob/src/sas/AccountSASServices.ts b/sdk/storage/storage-blob/src/sas/AccountSASServices.ts index ac95ac984816..8129d39e354d 100644 --- a/sdk/storage/storage-blob/src/sas/AccountSASServices.ts +++ b/sdk/storage/storage-blob/src/sas/AccountSASServices.ts @@ -9,19 +9,13 @@ * values are set, this should be serialized with toString and set as the services field on an * {@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 - * @class AccountSASServices */ export class AccountSASServices { /** * Creates an {@link AccountSASServices} from the specified services string. This method will throw an * Error if it encounters a character that does not correspond to a valid service. * - * @static * @param services - - * - * @memberof AccountSASServices */ public static parse(services: string): AccountSASServices { const accountSASServices = new AccountSASServices(); @@ -50,41 +44,27 @@ export class AccountSASServices { /** * Permission to access blob resources granted. - * - * @type {boolean} - * @memberof AccountSASServices */ public blob: boolean = false; /** * Permission to access file resources granted. - * - * @type {boolean} - * @memberof AccountSASServices */ public file: boolean = false; /** * Permission to access queue resources granted. - * - * @type {boolean} - * @memberof AccountSASServices */ public queue: boolean = false; /** * Permission to access table resources granted. - * - * @type {boolean} - * @memberof AccountSASServices */ public table: boolean = false; /** * Converts the given services to a string. * - * - * @memberof AccountSASServices */ public toString(): string { const services: string[] = []; diff --git a/sdk/storage/storage-blob/src/sas/AccountSASSignatureValues.ts b/sdk/storage/storage-blob/src/sas/AccountSASSignatureValues.ts index 348a968d52e8..0e82fa80b145 100644 --- a/sdk/storage/storage-blob/src/sas/AccountSASSignatureValues.ts +++ b/sdk/storage/storage-blob/src/sas/AccountSASSignatureValues.ts @@ -24,75 +24,48 @@ import { truncatedISO8061Date } from "../utils/utils.common"; * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas * for descriptions of the parameters, including which are required - * - * @export - * @class AccountSASSignatureValues */ export interface AccountSASSignatureValues { /** * If not provided, this defaults to the service version targeted by this version of the library. - * - * @type {string} - * @memberof AccountSASSignatureValues */ version?: string; /** * Optional. SAS protocols allowed. - * - * @type {SASProtocol} - * @memberof AccountSASSignatureValues */ protocol?: SASProtocol; /** * Optional. When the SAS will take effect. - * - * @type {Date} - * @memberof AccountSASSignatureValues */ startsOn?: Date; /** * The time after which the SAS will no longer work. - * - * @type {Date} - * @memberof AccountSASSignatureValues */ expiresOn: Date; /** * Specifies which operations the SAS user may perform. Please refer to {@link AccountSASPermissions} for help * constructing the permissions string. - * - * @type {AccountSASPermissions} - * @memberof AccountSASSignatureValues */ permissions: AccountSASPermissions; /** * Optional. IP range allowed. - * - * @type {SasIPRange} - * @memberof AccountSASSignatureValues */ ipRange?: SasIPRange; /** * The values that indicate the services accessible with this SAS. Please refer to {@link AccountSASServices} to * construct this value. - * - * @type {string} - * @memberof AccountSASSignatureValues */ services: string; /** * The values that indicate the resource types accessible with this SAS. Please refer * to {@link AccountSASResourceTypes} to construct this value. - * - * @type {string} - * @memberof AccountSASSignatureValues */ resourceTypes: string; } @@ -107,8 +80,6 @@ export interface AccountSASSignatureValues { * * @param accountSASSignatureValues - * @param sharedKeyCredential - - * - * @memberof AccountSASSignatureValues */ export function generateAccountSASQueryParameters( accountSASSignatureValues: AccountSASSignatureValues, diff --git a/sdk/storage/storage-blob/src/sas/BlobSASPermissions.ts b/sdk/storage/storage-blob/src/sas/BlobSASPermissions.ts index ce44bafbf371..97a118223f16 100644 --- a/sdk/storage/storage-blob/src/sas/BlobSASPermissions.ts +++ b/sdk/storage/storage-blob/src/sas/BlobSASPermissions.ts @@ -9,19 +9,13 @@ * the values are set, this should be serialized with toString and set as the permissions field on a * {@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 - * @class BlobSASPermissions */ export class BlobSASPermissions { /** * Creates a {@link BlobSASPermissions} from the specified permissions string. This method will throw an * Error if it encounters a character that does not correspond to a valid permission. * - * @static * @param permissions - - * - * @memberof BlobSASPermissions */ public static parse(permissions: string): BlobSASPermissions { const blobSASPermissions = new BlobSASPermissions(); @@ -67,10 +61,7 @@ export class BlobSASPermissions { * Creates a {@link BlobSASPermissions} from a raw object which contains same keys as it * and boolean values for them. * - * @static * @param permissionLike - - * - * @memberof BlobSASPermissions */ public static from(permissionLike: BlobSASPermissionsLike): BlobSASPermissions { const blobSASPermissions = new BlobSASPermissions(); @@ -106,73 +97,46 @@ export class BlobSASPermissions { /** * Specifies Read access granted. - * - * @type {boolean} - * @memberof BlobSASPermissions */ public read: boolean = false; /** * Specifies Add access granted. - * - * @type {boolean} - * @memberof BlobSASPermissions */ public add: boolean = false; /** * Specifies Create access granted. - * - * @type {boolean} - * @memberof BlobSASPermissions */ public create: boolean = false; /** * Specifies Write access granted. - * - * @type {boolean} - * @memberof BlobSASPermissions */ public write: boolean = false; /** * Specifies Delete access granted. - * - * @type {boolean} - * @memberof BlobSASPermissions */ public delete: boolean = false; /** * Specifies Delete version access granted. - * - * @type {boolean} - * @memberof BlobSASPermissions */ public deleteVersion: boolean = false; /** * Specfies Tag access granted. - * - * @type {boolean} - * @memberof BlobSASPermissions */ public tag: boolean = false; /** * Specifies Move access granted. - * - * @type {boolean} - * @memberof BlobSASPermissions */ public move: boolean = false; /** * Specifies Execute access granted. - * - * @type {boolean} - * @memberof BlobSASPermissions */ public execute: boolean = false; @@ -181,7 +145,6 @@ export class BlobSASPermissions { * order accepted by the service. * * @returns A string which represents the BlobSASPermissions - * @memberof BlobSASPermissions */ public toString(): string { const permissions: string[] = []; @@ -223,73 +186,46 @@ export class BlobSASPermissions { export interface BlobSASPermissionsLike { /** * Specifies Read access granted. - * - * @type {boolean} - * @memberof BlobSASPermissionsLike */ read?: boolean; /** * Specifies Add access granted. - * - * @type {boolean} - * @memberof BlobSASPermissionsLike */ add?: boolean; /** * Specifies Create access granted. - * - * @type {boolean} - * @memberof BlobSASPermissionsLike */ create?: boolean; /** * Specifies Write access granted. - * - * @type {boolean} - * @memberof BlobSASPermissionsLike */ write?: boolean; /** * Specifies Delete access granted. - * - * @type {boolean} - * @memberof BlobSASPermissionsLike */ delete?: boolean; /** * Specifies Delete version access granted. - * - * @type {boolean} - * @memberof BlobSASPermissionsLike */ deleteVersion?: boolean; /** * Specfies Tag access granted. - * - * @type {boolean} - * @memberof BlobSASPermissionsLike */ tag?: boolean; /** * Specifies Move access granted. - * - * @type {boolean} - * @memberof BlobSASPermissionsLike */ move?: boolean; /** * Specifies Execute access granted. - * - * @type {boolean} - * @memberof BlobSASPermissionsLike */ execute?: boolean; } diff --git a/sdk/storage/storage-blob/src/sas/BlobSASSignatureValues.ts b/sdk/storage/storage-blob/src/sas/BlobSASSignatureValues.ts index 448cf0eff003..9b183ddcf7d2 100644 --- a/sdk/storage/storage-blob/src/sas/BlobSASSignatureValues.ts +++ b/sdk/storage/storage-blob/src/sas/BlobSASSignatureValues.ts @@ -14,41 +14,26 @@ import { truncatedISO8061Date } from "../utils/utils.common"; * ONLY AVAILABLE IN NODE.JS RUNTIME. * * BlobSASSignatureValues is used to help generating Blob service SAS tokens for containers or blobs. - * - * @export - * @class BlobSASSignatureValues */ 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 BlobSASSignatureValues */ version?: string; /** * Optional. SAS protocols, HTTPS only or HTTPSandHTTP - * - * @type {SASProtocol} - * @memberof BlobSASSignatureValues */ protocol?: SASProtocol; /** * Optional. When the SAS will take effect. - * - * @type {Date} - * @memberof BlobSASSignatureValues */ startsOn?: Date; /** * Optional only when identifier is provided. The time after which the SAS will no longer work. - * - * @type {Date} - * @memberof BlobSASSignatureValues */ expiresOn?: Date; @@ -56,49 +41,31 @@ export interface BlobSASSignatureValues { * Optional only when identifier is provided. * Please refer to either {@link ContainerSASPermissions} or {@link BlobSASPermissions} depending on the resource * being accessed for help constructing the permissions string. - * - * @type {BlobSASPermissions | ContainerSASPermissions} - * @memberof BlobSASSignatureValues */ permissions?: BlobSASPermissions | ContainerSASPermissions; /** * Optional. IP ranges allowed in this SAS. - * - * @type {SasIPRange} - * @memberof BlobSASSignatureValues */ ipRange?: SasIPRange; /** * The name of the container the SAS user may access. - * - * @type {string} - * @memberof BlobSASSignatureValues */ containerName: string; /** * Optional. The blob name of the SAS user may access. Required if snapshotTime or versionId is provided. - * - * @type {string} - * @memberof BlobSASSignatureValues */ blobName?: string; /** * Optional. Snapshot timestamp string the SAS user may access. Only supported from API version 2018-11-09. - * - * @type {string} - * @memberof BlobSASSignatureValues */ snapshotTime?: string; /** * Optional. VersionId of the blob version the SAS user may access. Only supported from API version 2019-10-10. - * - * @type {string} - * @memberof BlobSASSignatureValues */ versionId?: string; @@ -106,49 +73,31 @@ export interface BlobSASSignatureValues { * Optional. The name of the access policy on the container this SAS references if any. * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy - * - * @type {string} - * @memberof BlobSASSignatureValues */ identifier?: string; /** * Optional. The cache-control header for the SAS. - * - * @type {string} - * @memberof BlobSASSignatureValues */ cacheControl?: string; /** * Optional. The content-disposition header for the SAS. - * - * @type {string} - * @memberof BlobSASSignatureValues */ contentDisposition?: string; /** * Optional. The content-encoding header for the SAS. - * - * @type {string} - * @memberof BlobSASSignatureValues */ contentEncoding?: string; /** * Optional. The content-language header for the SAS. - * - * @type {string} - * @memberof BlobSASSignatureValues */ contentLanguage?: string; /** * Optional. The content-type header for the SAS. - * - * @type {string} - * @memberof BlobSASSignatureValues */ contentType?: string; @@ -157,18 +106,12 @@ export interface BlobSASSignatureValues { * authorized by the owner of the user delegation key to perform the action granted by the SAS. The Azure Storage service will * ensure that the owner of the user delegation key has the required permissions before granting access but no additional permission * check for the user specified in this value will be performed. This is only used for User Delegation SAS. - * - * @type {string} - * @memberof BlobSASSignatureValues */ preauthorizedAgentObjectId?: string; /** * Optional. Beginning in version 2020-02-10, this is a GUID value that will be logged in the storage diagnostic logs and can be used to * correlate SAS generation with storage resource access. This is only used for User Delegation SAS. - * - * @type {string} - * @memberof BlobSASSignatureValues */ correlationId?: string; } @@ -253,10 +196,8 @@ export interface BlobSASSignatureValues { * ).toString(); * ``` * - * @export * @param blobSASSignatureValues - * @param sharedKeyCredential - - * */ export function generateBlobSASQueryParameters( blobSASSignatureValues: BlobSASSignatureValues, @@ -281,18 +222,16 @@ export function generateBlobSASQueryParameters( * expiresOn, // Required. Date type * ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional * protocol: SASProtocol.HttpsAndHttp, // Optional - * version: "2018-11-09" // Must >= 2018-11-09 to generate user delegation SAS + * version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS * }, * userDelegationKey, // UserDelegationKey * accountName * ).toString(); * ``` * - * @export * @param blobSASSignatureValues - * @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()` * @param accountName - - * */ export function generateBlobSASQueryParameters( blobSASSignatureValues: BlobSASSignatureValues, @@ -374,7 +313,6 @@ export function generateBlobSASQueryParameters( * * @param blobSASSignatureValues - * @param sharedKeyCredential - - * */ function generateBlobSASQueryParameters20150405( blobSASSignatureValues: BlobSASSignatureValues, @@ -472,7 +410,6 @@ function generateBlobSASQueryParameters20150405( * * @param blobSASSignatureValues - * @param sharedKeyCredential - - * */ function generateBlobSASQueryParameters20181109( blobSASSignatureValues: BlobSASSignatureValues, @@ -577,7 +514,6 @@ function generateBlobSASQueryParameters20181109( * * @param blobSASSignatureValues - * @param userDelegationKeyCredential - - * */ function generateBlobSASQueryParametersUDK20181109( blobSASSignatureValues: BlobSASSignatureValues, @@ -689,7 +625,6 @@ function generateBlobSASQueryParametersUDK20181109( * * @param blobSASSignatureValues - * @param userDelegationKeyCredential - - * */ function generateBlobSASQueryParametersUDK20200210( blobSASSignatureValues: BlobSASSignatureValues, diff --git a/sdk/storage/storage-blob/src/sas/ContainerSASPermissions.ts b/sdk/storage/storage-blob/src/sas/ContainerSASPermissions.ts index 5449f703474e..481cd1a12ae0 100644 --- a/sdk/storage/storage-blob/src/sas/ContainerSASPermissions.ts +++ b/sdk/storage/storage-blob/src/sas/ContainerSASPermissions.ts @@ -7,19 +7,13 @@ * Once all the values are set, this should be serialized with toString and set as the permissions field on a * {@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 - * @class ContainerSASPermissions */ export class ContainerSASPermissions { /** * Creates an {@link ContainerSASPermissions} from the specified permissions string. This method will throw an * Error if it encounters a character that does not correspond to a valid permission. * - * @static * @param permissions - - * - * @memberof ContainerSASPermissions */ public static parse(permissions: string) { const containerSASPermissions = new ContainerSASPermissions(); @@ -68,10 +62,7 @@ export class ContainerSASPermissions { * Creates a {@link ContainerSASPermissions} from a raw object which contains same keys as it * and boolean values for them. * - * @static * @param permissionLike - - * - * @memberof ContainerSASPermissions */ public static from(permissionLike: ContainerSASPermissionsLike): ContainerSASPermissions { const containerSASPermissions = new ContainerSASPermissions(); @@ -110,81 +101,51 @@ export class ContainerSASPermissions { /** * Specifies Read access granted. - * - * @type {boolean} - * @memberof ContainerSASPermissions */ public read: boolean = false; /** * Specifies Add access granted. - * - * @type {boolean} - * @memberof ContainerSASPermissions */ public add: boolean = false; /** * Specifies Create access granted. - * - * @type {boolean} - * @memberof ContainerSASPermissions */ public create: boolean = false; /** * Specifies Write access granted. - * - * @type {boolean} - * @memberof ContainerSASPermissions */ public write: boolean = false; /** * Specifies Delete access granted. - * - * @type {boolean} - * @memberof ContainerSASPermissions */ public delete: boolean = false; /** * Specifies Delete version access granted. - * - * @type {boolean} - * @memberof ContainerSASPermissions */ public deleteVersion: boolean = false; /** * Specifies List access granted. - * - * @type {boolean} - * @memberof ContainerSASPermissions */ public list: boolean = false; /** * Specfies Tag access granted. - * - * @type {boolean} - * @memberof ContainerSASPermissions */ public tag: boolean = false; /** * Specifies Move access granted. - * - * @type {boolean} - * @memberof ContainerSASPermissions */ public move: boolean = false; /** * Specifies Execute access granted. - * - * @type {boolean} - * @memberof ContainerSASPermissions */ public execute: boolean = false; @@ -195,8 +156,6 @@ export class ContainerSASPermissions { * The order of the characters should be as specified here to ensure correctness. * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas * - * - * @memberof ContainerSASPermissions */ public toString(): string { const permissions: string[] = []; @@ -241,81 +200,51 @@ export class ContainerSASPermissions { export interface ContainerSASPermissionsLike { /** * Specifies Read access granted. - * - * @type {boolean} - * @memberof ContainerSASPermissionsLike */ read?: boolean; /** * Specifies Add access granted. - * - * @type {boolean} - * @memberof ContainerSASPermissionsLike */ add?: boolean; /** * Specifies Create access granted. - * - * @type {boolean} - * @memberof ContainerSASPermissionsLike */ create?: boolean; /** * Specifies Write access granted. - * - * @type {boolean} - * @memberof ContainerSASPermissionsLike */ write?: boolean; /** * Specifies Delete access granted. - * - * @type {boolean} - * @memberof ContainerSASPermissionsLike */ delete?: boolean; /** * Specifies Delete version access granted. - * - * @type {boolean} - * @memberof ContainerSASPermissionsLike */ deleteVersion?: boolean; /** * Specifies List access granted. - * - * @type {boolean} - * @memberof ContainerSASPermissionsLike */ list?: boolean; /** * Specfies Tag access granted. - * - * @type {boolean} - * @memberof ContainerSASPermissionsLike */ tag?: boolean; /** * Specifies Move access granted. - * - * @type {boolean} - * @memberof ContainerSASPermissionsLike */ move?: boolean; /** * Specifies Execute access granted. - * - * @type {boolean} - * @memberof ContainerSASPermissionsLike */ execute?: boolean; } diff --git a/sdk/storage/storage-blob/src/sas/SASQueryParameters.ts b/sdk/storage/storage-blob/src/sas/SASQueryParameters.ts index 199b84689e14..7441f45f4a64 100644 --- a/sdk/storage/storage-blob/src/sas/SASQueryParameters.ts +++ b/sdk/storage/storage-blob/src/sas/SASQueryParameters.ts @@ -7,9 +7,6 @@ import { UserDelegationKey } from "../BlobServiceClient"; /** * Protocols for generated SAS. - * - * @export - * @enum {number} */ export enum SASProtocol { /** @@ -25,121 +22,73 @@ export enum SASProtocol { /** * Options to construct {@link SASQueryParameters}. - * - * @export - * @interface SASQueryParametersOptions */ export interface SASQueryParametersOptions { /** * Optional only when identifier is provided. * Please refer to {@link AccountSASPermissions}, {@link BlobSASPermissions}, or {@link ContainerSASPermissions} for * more details. - * - * @type {string} - * @memberof SASQueryParametersOptions */ permissions?: string; /** * Optional. The storage services being accessed (only for Account SAS). Please refer to {@link AccountSASServices} * for more details. - * - * @type {string} - * @memberof SASQueryParametersOptions */ services?: string; /** * Optional. The storage resource types being accessed (only for Account SAS). Please refer to * {@link AccountSASResourceTypes} for more details. - * - * @type {string} - * @memberof SASQueryParametersOptions */ resourceTypes?: string; /** * Optional. The allowed HTTP protocol(s). - * - * @type {SASProtocol} - * @memberof SASQueryParametersOptions */ protocol?: SASProtocol; /** * Optional. The start time for this SAS token. - * - * @type {Date} - * @memberof SASQueryParametersOptions */ startsOn?: Date; /** * Optional only when identifier is provided. The expiry time for this SAS token. - * - * @type {Date} - * @memberof SASQueryParametersOptions */ expiresOn?: Date; /** * Optional. IP ranges allowed in this SAS. - * - * @type {SasIPRange} - * @memberof SASQueryParametersOptions */ ipRange?: SasIPRange; /** * Optional. The signed identifier (only for {@link BlobSASSignatureValues}). * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy - * - * @type {string} - * @memberof SASQueryParametersOptions */ identifier?: string; /** * Optional. Specifies which resources are accessible via the SAS (only for {@link BlobSASSignatureValues}). * @see https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only - * - * @type {string} - * @memberof SASQueryParametersOptions */ resource?: string; /** * Value for cache-control header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParametersOptions */ cacheControl?: string; /** * Value for content-disposition header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParametersOptions */ contentDisposition?: string; /** * Value for content-encoding header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParametersOptions */ contentEncoding?: string; /** * Value for content-length header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParametersOptions */ contentLanguage?: string; /** * Value for content-type header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParametersOptions */ contentType?: string; /** * User delegation key properties. - * - * @type {UserDelegationKey} - * @memberof SASQueryParametersOptions */ userDelegationKey?: UserDelegationKey; /** @@ -148,17 +97,11 @@ export interface SASQueryParametersOptions { * has the required permissions before granting access but no additional permission check for the user specified in * this value will be performed. This cannot be used in conjuction with {@link signedUnauthorizedUserObjectId}. * This is only used for User Delegation SAS. - * - * @type {string} - * @memberof SASQueryParametersOptions */ preauthorizedAgentObjectId?: string; /** * A GUID value that will be logged in the storage diagnostic logs and can be used to correlate SAS generation with storage resource access. * This is only used for User Delegation SAS. - * - * @type {string} - * @memberof SASQueryParametersOptions */ correlationId?: string; } @@ -171,40 +114,25 @@ export interface SASQueryParametersOptions { * these query parameters). * * NOTE: Instances of this class are immutable. - * - * @export - * @class SASQueryParameters */ export class SASQueryParameters { /** * The storage API version. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly version: string; /** * Optional. The allowed HTTP protocol(s). - * - * @type {SASProtocol} - * @memberof SASQueryParameters */ public readonly protocol?: SASProtocol; /** * Optional. The start time for this SAS token. - * - * @type {Date} - * @memberof SASQueryParameters */ public readonly startsOn?: Date; /** * Optional only when identifier is provided. The expiry time for this SAS token. - * - * @type {Date} - * @memberof SASQueryParameters */ public readonly expiresOn?: Date; @@ -212,27 +140,18 @@ export class SASQueryParameters { * Optional only when identifier is provided. * Please refer to {@link AccountSASPermissions}, {@link BlobSASPermissions}, or {@link ContainerSASPermissions} for * more details. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly permissions?: string; /** * Optional. The storage services being accessed (only for Account SAS). Please refer to {@link AccountSASServices} * for more details. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly services?: string; /** * Optional. The storage resource types being accessed (only for Account SAS). Please refer to * {@link AccountSASResourceTypes} for more details. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly resourceTypes?: string; @@ -240,135 +159,83 @@ export class SASQueryParameters { * Optional. The signed identifier (only for {@link BlobSASSignatureValues}). * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy - * - * @type {string} - * @memberof SASQueryParameters */ public readonly identifier?: string; /** * Optional. Specifies which resources are accessible via the SAS (only for {@link BlobSASSignatureValues}). * @see https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only - * - * @type {string} - * @memberof SASQueryParameters */ public readonly resource?: string; /** * The signature for the SAS token. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly signature: string; /** * Value for cache-control header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly cacheControl?: string; /** * Value for content-disposition header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly contentDisposition?: string; /** * Value for content-encoding header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly contentEncoding?: string; /** * Value for content-length header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly contentLanguage?: string; /** * Value for content-type header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly contentType?: string; /** * Inner value of getter ipRange. - * - * @private - * @type {SasIPRange} - * @memberof SASQueryParameters */ private readonly ipRangeInner?: SasIPRange; /** * The Azure Active Directory object ID in GUID format. * Property of user delegation key. - * - * @private - * @type {string} - * @memberof SASQueryParameters */ private readonly signedOid?: string; /** * The Azure Active Directory tenant ID in GUID format. * Property of user delegation key. - * - * @private - * @type {string} - * @memberof SASQueryParameters */ private readonly signedTenantId?: string; /** * The date-time the key is active. * Property of user delegation key. - * - * @private - * @type {Date} - * @memberof SASQueryParameters */ private readonly signedStartsOn?: Date; /** * The date-time the key expires. * Property of user delegation key. - * - * @private - * @type {Date} - * @memberof SASQueryParameters */ private readonly signedExpiresOn?: Date; /** * Abbreviation of the Azure Storage service that accepts the user delegation key. * Property of user delegation key. - * - * @private - * @type {string} - * @memberof SASQueryParameters */ private readonly signedService?: string; /** * The service version that created the user delegation key. * Property of user delegation key. - * - * @private - * @type {string} - * @memberof SASQueryParameters */ private readonly signedVersion?: string; @@ -377,18 +244,12 @@ export class SASQueryParameters { * to perform the action granted by the SAS. The Azure Storage service will ensure that the owner of the user delegation key * has the required permissions before granting access but no additional permission check for the user specified in * this value will be performed. This is only used for User Delegation SAS. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly preauthorizedAgentObjectId?: string; /** * A GUID value that will be logged in the storage diagnostic logs and can be used to correlate SAS generation with storage resource access. * This is only used for User Delegation SAS. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly correlationId?: string; @@ -396,8 +257,6 @@ export class SASQueryParameters { * Optional. IP range allowed for this SAS. * * @readonly - * @type {(SasIPRange | undefined)} - * @memberof SASQueryParameters */ public get ipRange(): SasIPRange | undefined { if (this.ipRangeInner) { @@ -431,7 +290,6 @@ export class SASQueryParameters { * @param userDelegationKey - Representing the user delegation key properties * @param preauthorizedAgentObjectId - Representing the authorized AAD Object ID (only for User Delegation SAS) * @param correlationId - Representing the correlation ID (only for User Delegation SAS) - * @memberof SASQueryParameters */ constructor( version: string, @@ -461,7 +319,6 @@ export class SASQueryParameters { * @param version - Representing the storage version * @param signature - Representing the signature for the SAS token * @param options - Optional. Options to construct the SASQueryParameters. - * @memberof SASQueryParameters */ constructor(version: string, signature: string, options?: SASQueryParametersOptions); @@ -550,8 +407,6 @@ export class SASQueryParameters { /** * Encodes all SAS query parameters into a string that can be appended to a URL. * - * - * @memberof SASQueryParameters */ public toString(): string { const params: string[] = [ @@ -684,12 +539,9 @@ export class SASQueryParameters { /** * A private helper method used to filter and append query key/value pairs into an array. * - * @private * @param queries - * @param key - * @param value - - * - * @memberof SASQueryParameters */ private tryAppendQueryParameter(queries: string[], key: string, value?: string): void { if (!value) { diff --git a/sdk/storage/storage-blob/src/sas/SasIPRange.ts b/sdk/storage/storage-blob/src/sas/SasIPRange.ts index 08932c50e16b..516894476648 100644 --- a/sdk/storage/storage-blob/src/sas/SasIPRange.ts +++ b/sdk/storage/storage-blob/src/sas/SasIPRange.ts @@ -3,25 +3,16 @@ /** * Allowed IP range for a SAS. - * - * @export - * @interface SasIPRange */ export interface SasIPRange { /** * Starting IP address in the IP range. * If end IP doesn't provide, start IP will the only IP allowed. - * - * @type {string} - * @memberof SasIPRange */ start: string; /** * Optional. IP address that ends the IP range. * If not provided, start IP will the only IP allowed. - * - * @type {string} - * @memberof SasIPRange */ end?: string; } @@ -31,9 +22,7 @@ export interface SasIPRange { * * "8.8.8.8" or "1.1.1.1-255.255.255.255" * - * @export * @param ipRange - - * */ export function ipRangeToString(ipRange: SasIPRange): string { return ipRange.end ? `${ipRange.start}-${ipRange.end}` : ipRange.start; diff --git a/sdk/storage/storage-blob/src/utils/Batch.ts b/sdk/storage/storage-blob/src/utils/Batch.ts index e1402136d5b3..4dc05d4e622a 100644 --- a/sdk/storage/storage-blob/src/utils/Batch.ts +++ b/sdk/storage/storage-blob/src/utils/Batch.ts @@ -12,8 +12,6 @@ export declare type Operation = () => Promise; /** * States for Batch. - * - * @enum {number} */ enum BatchStates { Good, @@ -24,78 +22,47 @@ enum BatchStates { * Batch provides basic parallel execution with concurrency limits. * Will stop execute left operations when one of the executed operation throws an error. * But Batch cannot cancel ongoing operations, you need to cancel them by yourself. - * - * @export - * @class Batch */ export class Batch { /** * Concurrency. Must be lager than 0. - * - * @type {number} - * @memberof Batch */ private concurrency: number; /** * Number of active operations under execution. - * - * @private - * @type {number} - * @memberof Batch */ private actives: number = 0; /** * Number of completed operations under execution. - * - * @private - * @type {number} - * @memberof Batch */ private completed: number = 0; /** * Offset of next operation to be executed. - * - * @private - * @type {number} - * @memberof Batch */ private offset: number = 0; /** * Operation array to be executed. - * - * @private - * @type {Operation[]} - * @memberof Batch */ private operations: Operation[] = []; /** * States of Batch. When an error happens, state will turn into error. * Batch will stop execute left operations. - * - * @private - * @type {BatchStates} - * @memberof Batch */ private state: BatchStates = BatchStates.Good; /** * A private emitter used to pass events inside this class. - * - * @private - * @type {EventEmitter} - * @memberof Batch */ private emitter: EventEmitter; /** * Creates an instance of Batch. * @param concurrency - - * @memberof Batch */ public constructor(concurrency: number = 5) { if (concurrency < 1) { @@ -109,7 +76,6 @@ export class Batch { * Add a operation into queue. * * @param operation - - * @memberof Batch */ public addOperation(operation: Operation): void { this.operations.push(async () => { @@ -128,8 +94,6 @@ export class Batch { /** * Start execute operations in the queue. * - * - * @memberof Batch */ public async do(): Promise { if (this.operations.length === 0) { @@ -151,9 +115,6 @@ export class Batch { /** * Get next operation to be executed. Return null when reaching ends. * - * @private - * - * @memberof Batch */ private nextOperation(): Operation | null { if (this.offset < this.operations.length) { @@ -166,9 +127,6 @@ export class Batch { * Start execute operations. One one the most important difference between * this method with do() is that do() wraps as an sync method. * - * @private - * - * @memberof Batch */ private parallelExecute(): void { if (this.state === BatchStates.Error) { diff --git a/sdk/storage/storage-blob/src/utils/BlobQuickQueryStream.ts b/sdk/storage/storage-blob/src/utils/BlobQuickQueryStream.ts index 863d75a97322..364144aec489 100644 --- a/sdk/storage/storage-blob/src/utils/BlobQuickQueryStream.ts +++ b/sdk/storage/storage-blob/src/utils/BlobQuickQueryStream.ts @@ -13,23 +13,16 @@ export interface BlobQuickQueryStreamOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof BlobQuickQueryStreamOptions */ abortSignal?: AbortSignalLike; /** * Read progress event handler - * - * @memberof BlobQuickQueryStreamOptions */ onProgress?: (progress: TransferProgressEvent) => void; /** * Callback to receive error events during the query operaiton. - * - * @memberof BlockBlobQueryOptions */ onError?: (error: BlobQueryError) => void; } @@ -38,9 +31,6 @@ export interface BlobQuickQueryStreamOptions { * ONLY AVAILABLE IN NODE.JS RUNTIME. * * A Node.js BlobQuickQueryStream will internally parse avro data stream for blob query. - * - * @class BlobQuickQueryStream - * @extends {Readable} */ export class BlobQuickQueryStream extends Readable { private source: NodeJS.ReadableStream; @@ -55,7 +45,6 @@ export class BlobQuickQueryStream extends Readable { * * @param source - The current ReadableStream returned from getter * @param options - - * @memberof BlobQuickQueryStream */ public constructor(source: NodeJS.ReadableStream, options: BlobQuickQueryStreamOptions = {}) { super(); diff --git a/sdk/storage/storage-blob/src/utils/Mutex.ts b/sdk/storage/storage-blob/src/utils/Mutex.ts index e608432196a9..dc59c2d9bb0b 100644 --- a/sdk/storage/storage-blob/src/utils/Mutex.ts +++ b/sdk/storage/storage-blob/src/utils/Mutex.ts @@ -10,19 +10,13 @@ type Callback = (...args: any[]) => any; /** * An async mutex lock. - * - * @export - * @class Mutex */ export class Mutex { /** * Lock for a specific key. If the lock has been acquired by another customer, then * will wait until getting the lock. * - * @static * @param key - lock key - * - * @memberof Mutex */ public static async lock(key: string): Promise { return new Promise((resolve) => { @@ -41,10 +35,7 @@ export class Mutex { /** * Unlock a key. * - * @static * @param key - - * - * @memberof Mutex */ public static async unlock(key: string): Promise { return new Promise((resolve) => { diff --git a/sdk/storage/storage-blob/src/utils/RetriableReadableStream.ts b/sdk/storage/storage-blob/src/utils/RetriableReadableStream.ts index c9fdbdd5fe9b..cba8672705f6 100644 --- a/sdk/storage/storage-blob/src/utils/RetriableReadableStream.ts +++ b/sdk/storage/storage-blob/src/utils/RetriableReadableStream.ts @@ -8,17 +8,12 @@ export type ReadableStreamGetter = (offset: number) => Promise=0), undefined or invalid value means no retry - * - * @type {number} - * @memberof RetriableReadableStreamOptions + * Max retry count (greater than or equal to 0), undefined or invalid value means no retry */ maxRetryRequests?: number; /** * Read progress event handler - * - * @memberof RetriableReadableStreamOptions */ onProgress?: (progress: TransferProgressEvent) => void; @@ -30,17 +25,11 @@ export interface RetriableReadableStreamOptions { * RetriableReadableStream will try to emit an "end" event to existing internal * stream to force it end and start retry from the breaking point. * The value will then update to "undefined", once the injection works. - * - * @type {boolean} - * @memberof RetriableReadableStreamOptions */ doInjectErrorOnce?: boolean; /** * A threshold, not a limit. Dictates the amount of data that a stream buffers before it stops asking for more data. - * - * @type {number} - * @memberof RetriableReadableStreamOptions */ highWaterMark?: number; } @@ -49,9 +38,6 @@ export interface RetriableReadableStreamOptions { * ONLY AVAILABLE IN NODE.JS RUNTIME. * * A Node.js ReadableStream will internally retry when internal ReadableStream unexpected ends. - * - * @class RetriableReadableStream - * @extends {Readable} */ export class RetriableReadableStream extends Readable { private start: number; @@ -73,7 +59,6 @@ export class RetriableReadableStream extends Readable { * @param offset - Offset position in original data source to read * @param count - How much data in original data source to read * @param options - - * @memberof RetriableReadableStream */ public constructor( source: NodeJS.ReadableStream, diff --git a/sdk/storage/storage-blob/src/utils/tracing.ts b/sdk/storage/storage-blob/src/utils/tracing.ts index 83e0c765f1a4..b84e961499f0 100644 --- a/sdk/storage/storage-blob/src/utils/tracing.ts +++ b/sdk/storage/storage-blob/src/utils/tracing.ts @@ -6,8 +6,8 @@ import { Span, SpanOptions as OTSpanOptions, SpanKind } from "@opentelemetry/api /** * Creates a span using the global tracer. - * @param name The name of the operation being performed. - * @param tracingOptions The options for the underlying http request. + * @param name - The name of the operation being performed. + * @param tracingOptions - The options for the underlying http request. */ export function createSpan( operationName: string, diff --git a/sdk/storage/storage-blob/src/utils/utils.browser.ts b/sdk/storage/storage-blob/src/utils/utils.browser.ts index 290b9bcc6487..a125ae18e017 100644 --- a/sdk/storage/storage-blob/src/utils/utils.browser.ts +++ b/sdk/storage/storage-blob/src/utils/utils.browser.ts @@ -4,9 +4,7 @@ /** * Convert a Browser Blob object into ArrayBuffer. * - * @export * @param blob - - * */ export async function blobToArrayBuffer(blob: Blob): Promise { const fileReader = new FileReader(); @@ -22,9 +20,7 @@ export async function blobToArrayBuffer(blob: Blob): Promise { /** * Convert a Browser Blob object into string. * - * @export * @param blob - - * */ export async function blobToString(blob: Blob): Promise { const fileReader = new FileReader(); diff --git a/sdk/storage/storage-blob/src/utils/utils.common.ts b/sdk/storage/storage-blob/src/utils/utils.common.ts index e5d2a0cf0c32..03b832b846b2 100644 --- a/sdk/storage/storage-blob/src/utils/utils.common.ts +++ b/sdk/storage/storage-blob/src/utils/utils.common.ts @@ -68,9 +68,7 @@ import { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata * @see https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-shares--directories--files--and-metadata * - * @export * @param url - - * */ export function escapeURLPath(url: string): string { const urlParsed = URLBuilder.parse(url); @@ -131,7 +129,6 @@ export function getValueInConnString( /** * Extracts the parts of an Azure Storage account connection string. * - * @export * @param connectionString - Connection string. * @returns String key value pairs of the storage account's url and credentials. */ @@ -216,7 +213,6 @@ export function extractConnectionStringParts(connectionString: string): Connecti * Internal escape method implemented Strategy Two mentioned in escapeURL() description. * * @param text - - * */ function escape(text: string): string { return encodeURIComponent(text) @@ -230,7 +226,6 @@ function escape(text: string): string { * Append a string to URL path. Will remove duplicated "/" in front of the string * when URL path ends with a "/". * - * @export * @param url - Source URL string * @param name - String to be appended to URL * @returns An updated URL string @@ -249,7 +244,6 @@ export function appendToURLPath(url: string, name: string): string { * Set URL parameter name and value. If name exists in URL parameters, old value * will be replaced by name key. If not provide value, the parameter will be deleted. * - * @export * @param url - Source URL string * @param name - Parameter name * @param value - Parameter value @@ -264,10 +258,8 @@ export function setURLParameter(url: string, name: string, value?: string): stri /** * Get URL parameter by name. * - * @export * @param url - * @param name - - * */ export function getURLParameter(url: string, name: string): string | string[] | undefined { const urlParsed = URLBuilder.parse(url); @@ -277,7 +269,6 @@ export function getURLParameter(url: string, name: string): string | string[] | /** * Set URL host. * - * @export * @param url - Source URL string * @param host - New host string * @returns An updated URL string @@ -291,9 +282,7 @@ export function setURLHost(url: string, host: string): string { /** * Get URL path from an URL string. * - * @export * @param url - Source URL string - * */ export function getURLPath(url: string): string | undefined { const urlParsed = URLBuilder.parse(url); @@ -303,9 +292,7 @@ export function getURLPath(url: string): string | undefined { /** * Get URL scheme from an URL string. * - * @export * @param url - Source URL string - * */ export function getURLScheme(url: string): string | undefined { const urlParsed = URLBuilder.parse(url); @@ -315,9 +302,7 @@ export function getURLScheme(url: string): string | undefined { /** * Get URL path and query from an URL string. * - * @export * @param url - Source URL string - * */ export function getURLPathAndQuery(url: string): string | undefined { const urlParsed = URLBuilder.parse(url); @@ -338,9 +323,7 @@ export function getURLPathAndQuery(url: string): string | undefined { /** * Get URL query key value pairs from an URL string. * - * @export * @param url - - * */ export function getURLQueries(url: string): { [key: string]: string } { let queryString = URLBuilder.parse(url).getQuery(); @@ -374,7 +357,6 @@ export function getURLQueries(url: string): { [key: string]: string } { /** * Append a string to URL query. * - * @export * @param url - Source URL string. * @param queryParts - String to be appended to the URL query. * @returns An updated URL string. @@ -396,7 +378,6 @@ export function appendToURLQuery(url: string, queryParts: string): string { /** * Rounds a date off to seconds. * - * @export * @param date - * @param withMilliseconds - If true, YYYY-MM-DDThh:mm:ss.fffffffZ will be returned; * If false, YYYY-MM-DDThh:mm:ssZ will be returned. @@ -414,9 +395,7 @@ export function truncatedISO8061Date(date: Date, withMilliseconds: boolean = tru /** * Base64 encode. * - * @export * @param content - - * */ export function base64encode(content: string): string { return !isNode ? btoa(content) : Buffer.from(content).toString("base64"); @@ -425,9 +404,7 @@ export function base64encode(content: string): string { /** * Base64 decode. * - * @export * @param encodedString - - * */ export function base64decode(encodedString: string): string { return !isNode ? atob(encodedString) : Buffer.from(encodedString, "base64").toString(); @@ -436,9 +413,7 @@ export function base64decode(encodedString: string): string { /** * Generate a 64 bytes base64 block ID string. * - * @export * @param blockIndex - - * */ export function generateBlockID(blockIDPrefix: string, blockIndex: number): string { // To generate a 64 bytes base64 string, source string should be 48 @@ -461,7 +436,6 @@ export function generateBlockID(blockIDPrefix: string, blockIndex: number): stri /** * Delay specified time interval. * - * @export * @param timeInMs - * @param aborter - * @param abortError - @@ -494,11 +468,9 @@ export async function delay(timeInMs: number, aborter?: AbortSignalLike, abortEr /** * String.prototype.padStart() * - * @export * @param currentString - * @param targetLength - - * @param [padString=" - "] - * + * @param padString - */ export function padStart( currentString: string, @@ -549,10 +521,8 @@ export function sanitizeHeaders(originalHeader: HttpHeaders): HttpHeaders { /** * If two strings are equal when compared case insensitive. * - * @export * @param str1 - * @param str2 - - * */ export function iEqual(str1: string, str2: string): boolean { return str1.toLocaleLowerCase() === str2.toLocaleLowerCase(); @@ -605,9 +575,7 @@ export function isIpEndpointStyle(parsedUrl: URLBuilder): boolean { /** * Convert Tags to encoded string. * - * @export * @param tags - - * */ export function toBlobTagsString(tags?: Tags): string | undefined { if (tags === undefined) { @@ -628,9 +596,7 @@ export function toBlobTagsString(tags?: Tags): string | undefined { /** * Convert Tags type to BlobTags. * - * @export * @param tags - - * */ export function toBlobTags(tags?: Tags): BlobTags | undefined { if (tags === undefined) { @@ -656,9 +622,7 @@ export function toBlobTags(tags?: Tags): BlobTags | undefined { /** * Covert BlobTags to Tags type. * - * @export * @param tags - - * */ export function toTags(tags?: BlobTags): Tags | undefined { if (tags === undefined) { @@ -675,9 +639,7 @@ export function toTags(tags?: BlobTags): Tags | undefined { /** * Convert BlobQueryTextConfiguration to QuerySerialization type. * - * @export * @param textConfiguration - - * */ export function toQuerySerialization( textConfiguration?: @@ -767,10 +729,8 @@ export function parseObjectReplicationRecord( /** * Attach a TokenCredential to an object. * - * @export * @param thing - * @param credential - - * */ export function attachCredential(thing: T, credential: TokenCredential): T { (thing as any).credential = credential; diff --git a/sdk/storage/storage-blob/src/utils/utils.node.ts b/sdk/storage/storage-blob/src/utils/utils.node.ts index bed0313b10c9..98f2b3a78c61 100644 --- a/sdk/storage/storage-blob/src/utils/utils.node.ts +++ b/sdk/storage/storage-blob/src/utils/utils.node.ts @@ -7,13 +7,11 @@ import * as util from "util"; /** * Reads a readable stream into buffer. Fill the buffer from offset to end. * - * @export * @param stream - A Node.js Readable stream - * @param buffer - Buffer to be filled, length must >= offset + * @param buffer - Buffer to be filled, length must greater than or equal to offset * @param offset - From which position in the buffer to be filled, inclusive * @param end - To which position in the buffer to be filled, exclusive * @param encoding - Encoding of the Readable stream - * */ export async function streamToBuffer( stream: NodeJS.ReadableStream, @@ -65,12 +63,11 @@ export async function streamToBuffer( /** * Reads a readable stream into buffer entirely. * - * @export * @param stream - A Node.js Readable stream - * @param buffer - Buffer to be filled, length must >= offset + * @param buffer - Buffer to be filled, length must greater than or equal to offset * @param encoding - Encoding of the Readable stream * @returns with the count of bytes read. - * @throws {RangeError} If buffer size is not big enough. + * @throws `RangeError` If buffer size is not big enough. */ export async function streamToBuffer2( stream: NodeJS.ReadableStream, @@ -110,7 +107,6 @@ export async function streamToBuffer2( /** * Reads a readable stream into a buffer. * - * @export * @param stream - A Node.js Readable stream * @param encoding - Encoding of the Readable stream * @returns with the count of bytes read. @@ -136,10 +132,8 @@ export async function streamToBuffer3( * * Writes the content of a readstream to a local file. Returns a Promise which is completed after the file handle is closed. * - * @export * @param rs - The read stream. * @param file - Destination file path. - * */ export async function readStreamToLocalFile( rs: NodeJS.ReadableStream, diff --git a/sdk/storage/storage-blob/test/utils/InjectorPolicy.ts b/sdk/storage/storage-blob/test/utils/InjectorPolicy.ts index f7bc41bec26a..a4a7e192b413 100644 --- a/sdk/storage/storage-blob/test/utils/InjectorPolicy.ts +++ b/sdk/storage/storage-blob/test/utils/InjectorPolicy.ts @@ -18,9 +18,6 @@ export type Injector = () => RestError | undefined; /** * InjectorPolicy will inject a customized error before next HTTP request. - * - * @class InjectorPolicy - * @extends {BaseRequestPolicy} */ export class InjectorPolicy extends BaseRequestPolicy { /** @@ -28,7 +25,6 @@ export class InjectorPolicy extends BaseRequestPolicy { * * @param nextPolicy - * @param options - - * @memberof InjectorPolicy */ public constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, injector: Injector) { super(nextPolicy, options); @@ -39,8 +35,6 @@ export class InjectorPolicy extends BaseRequestPolicy { * Sends request. * * @param request - - * - * @memberof InjectorPolicy */ public async sendRequest(request: WebResource): Promise { const error = this.injector(); diff --git a/sdk/storage/storage-blob/test/utils/InjectorPolicyFactory.ts b/sdk/storage/storage-blob/test/utils/InjectorPolicyFactory.ts index 09fc932ec95d..b0c36c384558 100644 --- a/sdk/storage/storage-blob/test/utils/InjectorPolicyFactory.ts +++ b/sdk/storage/storage-blob/test/utils/InjectorPolicyFactory.ts @@ -6,10 +6,6 @@ import { InjectorPolicy, Injector } from "./InjectorPolicy"; /** * InjectorPolicyFactory is a factory class which injects customized errors for retry policy testing. - * - * @export - * @class InjectorPolicyFactory - * @implements {RequestPolicyFactory} */ export class InjectorPolicyFactory implements RequestPolicyFactory { public readonly injector: Injector; diff --git a/sdk/storage/storage-blob/test/utils/index.browser.ts b/sdk/storage/storage-blob/test/utils/index.browser.ts index bbdad0ac9283..eb854f658e0a 100644 --- a/sdk/storage/storage-blob/test/utils/index.browser.ts +++ b/sdk/storage/storage-blob/test/utils/index.browser.ts @@ -89,8 +89,8 @@ export function getAlternateBSU(): BlobServiceClient { * Read body from downloading operation methods to string. * Works in both Node.js and browsers. * - * @param response Convenience layer methods response with downloaded body - * @param length Length of Readable stream, needed for Node.js environment + * @param response - Convenience layer methods response with downloaded body + * @param length - Length of Readable stream, needed for Node.js environment */ export async function bodyToString( response: { diff --git a/sdk/storage/storage-blob/test/utils/index.ts b/sdk/storage/storage-blob/test/utils/index.ts index 36b9f383acd4..19f67cd3f850 100644 --- a/sdk/storage/storage-blob/test/utils/index.ts +++ b/sdk/storage/storage-blob/test/utils/index.ts @@ -144,8 +144,8 @@ export function getConnectionStringFromEnvironment(): string { * Read body from downloading operation methods to string. * Works in both Node.js and browsers. * - * @param response Convenience layer methods response with downloaded body - * @param length Length of Readable stream, needed for Node.js environment + * @param response - Convenience layer methods response with downloaded body + * @param length - Length of Readable stream, needed for Node.js environment */ export async function bodyToString( response: { diff --git a/sdk/storage/storage-blob/test/utils/testutils.common.ts b/sdk/storage/storage-blob/test/utils/testutils.common.ts index 2c496d018550..443624d4cad9 100644 --- a/sdk/storage/storage-blob/test/utils/testutils.common.ts +++ b/sdk/storage/storage-blob/test/utils/testutils.common.ts @@ -97,8 +97,8 @@ export class SimpleTokenCredential implements TokenCredential { /** * Retrieves the token stored in this RawTokenCredential. * - * @param _scopes Ignored since token is already known. - * @param _options Ignored since token is already known. + * @param _scopes - Ignored since token is already known. + * @param _options - Ignored since token is already known. * @returns The access token details. */ async getToken( @@ -137,8 +137,8 @@ type BlobMetadata = { [propertyName: string]: string }; /** * Validate if m1 is super set of m2. * - * @param m1 BlobMetadata - * @param m2 BlobMetadata + * @param m1 - BlobMetadata + * @param m2 - BlobMetadata */ export function isSuperSet(m1?: BlobMetadata, m2?: BlobMetadata): boolean { if (!m1 || !m2) { @@ -157,9 +157,7 @@ export function isSuperSet(m1?: BlobMetadata, m2?: BlobMetadata): boolean { /** * Sleep for seconds. * - * @export * @param seconds - - * */ export function sleep(seconds: number): Promise { return new Promise((resolve) => { @@ -170,9 +168,7 @@ export function sleep(seconds: number): Promise { /** * Generate a Uint8Array with specified byteLength and randome content. * - * @export * @param byteLength - - * */ export function genearteRandomUint8Array(byteLength: number): Uint8Array { const uint8Arr = new Uint8Array(byteLength); diff --git a/sdk/storage/storage-blob/test/utils/testutils.node.ts b/sdk/storage/storage-blob/test/utils/testutils.node.ts index 743ad6092c24..c91fd7afb195 100644 --- a/sdk/storage/storage-blob/test/utils/testutils.node.ts +++ b/sdk/storage/storage-blob/test/utils/testutils.node.ts @@ -10,10 +10,8 @@ import * as fs from "fs"; * If Promise is rejected, the reason will be set to the first error raised by either the * ReadableStream or the fs.WriteStream. * - * @export * @param rs - The read stream. * @param file - Destination file path. - * */ export async function readStreamToLocalFileWithLogs( rs: NodeJS.ReadableStream, diff --git a/sdk/storage/storage-common/src/BufferScheduler.ts b/sdk/storage/storage-common/src/BufferScheduler.ts index 9c12ac669ebf..6435aba9059e 100644 --- a/sdk/storage/storage-common/src/BufferScheduler.ts +++ b/sdk/storage/storage-common/src/BufferScheduler.ts @@ -26,7 +26,7 @@ export declare type OutgoingHandler = ( * * NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING * - * NUM_OF_ALL_BUFFERS <= maxBuffers + * NUM_OF_ALL_BUFFERS lesser than or equal to maxBuffers * * PERFORMANCE IMPROVEMENT TIPS: * 1. Input stream highWaterMark is better to set a same value with bufferSize @@ -35,117 +35,67 @@ export declare type OutgoingHandler = ( * reduce the possibility when a outgoing handler waits for the stream data. * in this situation, outgoing handlers are blocked. * Outgoing queue shouldn't be empty. - * @export - * @class BufferScheduler */ export class BufferScheduler { /** * Size of buffers in incoming and outgoing queues. This class will try to align * data read from Readable stream into buffer chunks with bufferSize defined. - * - * @private - * @type {number} - * @memberof BufferScheduler */ private readonly bufferSize: number; /** * How many buffers can be created or maintained. - * - * @private - * @type {number} - * @memberof BufferScheduler */ private readonly maxBuffers: number; /** * A Node.js Readable stream. - * - * @private - * @type {Readable} - * @memberof BufferScheduler */ private readonly readable: Readable; /** * OutgoingHandler is an async function triggered by BufferScheduler when there * are available buffers in outgoing array. - * - * @private - * @type {OutgoingHandler} - * @memberof BufferScheduler */ private readonly outgoingHandler: OutgoingHandler; /** * An internal event emitter. - * - * @private - * @type {EventEmitter} - * @memberof BufferScheduler */ private readonly emitter: EventEmitter = new EventEmitter(); /** - * Concurrency of executing outgoingHandlers. (0 < concurrency <= maxBuffers) - * - * @private - * @type {number} - * @memberof BufferScheduler + * Concurrency of executing outgoingHandlers. (0 lesser than concurrency lesser than or equal to maxBuffers) */ private readonly concurrency: number; /** * An internal offset marker to track data offset in bytes of next outgoingHandler. - * - * @private - * @type {number} - * @memberof BufferScheduler */ private offset: number = 0; /** * An internal marker to track whether stream is end. - * - * @private - * @type {boolean} - * @memberof BufferScheduler */ private isStreamEnd: boolean = false; /** * An internal marker to track whether stream or outgoingHandler returns error. - * - * @private - * @type {boolean} - * @memberof BufferScheduler */ private isError: boolean = false; /** * How many handlers are executing. - * - * @private - * @type {number} - * @memberof BufferScheduler */ private executingOutgoingHandlers: number = 0; /** * Encoding of the input Readable stream which has string data type instead of Buffer. - * - * @private - * @type {string} - * @memberof BufferScheduler */ private encoding?: string; /** * How many buffers have been allocated. - * - * @private - * @type {number} - * @memberof BufferScheduler */ private numBuffers: number = 0; @@ -155,37 +105,21 @@ export class BufferScheduler { * data received from the stream, when data in unresolvedDataArray exceeds the * blockSize defined, it will try to concat a blockSize of buffer, fill into available * buffers from incoming and push to outgoing array. - * - * @private - * @type {Buffer[]} - * @memberof BufferScheduler */ private unresolvedDataArray: Buffer[] = []; /** * How much data consisted in unresolvedDataArray. - * - * @private - * @type {number} - * @memberof BufferScheduler */ private unresolvedLength: number = 0; /** * The array includes all the available buffers can be used to fill data from stream. - * - * @private - * @type {PooledBuffer[]} - * @memberof BufferScheduler */ private incoming: PooledBuffer[] = []; /** * The array (queue) includes all the buffers filled from stream data. - * - * @private - * @type {PooledBuffer[]} - * @memberof BufferScheduler */ private outgoing: PooledBuffer[] = []; @@ -200,7 +134,6 @@ export class BufferScheduler { * with stream data * @param concurrency - Concurrency of executing outgoingHandlers (>0) * @param encoding - [Optional] Encoding of Readable stream when it's a string stream - * @memberof BufferScheduler */ constructor( readable: Readable, @@ -234,8 +167,6 @@ export class BufferScheduler { * Start the scheduler, will return error when stream of any of the outgoingHandlers * returns error. * - * - * @memberof BufferScheduler */ public async do(): Promise { return new Promise((resolve, reject) => { @@ -288,9 +219,7 @@ export class BufferScheduler { /** * Insert a new data into unresolved array. * - * @private * @param data - - * @memberof BufferScheduler */ private appendUnresolvedData(data: Buffer) { this.unresolvedDataArray.push(data); @@ -301,9 +230,6 @@ export class BufferScheduler { * Try to shift a buffer with size in blockSize. The buffer returned may be less * than blockSize when data in unresolvedDataArray is less than bufferSize. * - * @private - * - * @memberof BufferScheduler */ private shiftBufferFromUnresolvedDataArray(buffer?: PooledBuffer): PooledBuffer { if (!buffer) { @@ -323,9 +249,7 @@ export class BufferScheduler { * * Return false when available buffers in incoming are not enough, else true. * - * @private * @returns Return false when buffers in incoming are not enough, else true. - * @memberof BufferScheduler */ private resolveData(): boolean { while (this.unresolvedLength >= this.bufferSize) { @@ -353,9 +277,6 @@ export class BufferScheduler { /** * Try to trigger a outgoing handler for every buffer in outgoing. Stop when * concurrency reaches. - * - * @private - * @memberof BufferScheduler */ private async triggerOutgoingHandlers() { let buffer: PooledBuffer | undefined; @@ -374,10 +295,7 @@ export class BufferScheduler { /** * Trigger a outgoing handler for a buffer shifted from outgoing. * - * @private * @param buffer - - * - * @memberof BufferScheduler */ private async triggerOutgoingHandler(buffer: PooledBuffer): Promise { const bufferLength = buffer.size; @@ -404,9 +322,7 @@ export class BufferScheduler { /** * Return buffer used by outgoing handler into incoming. * - * @private * @param buffer - - * @memberof BufferScheduler */ private reuseBuffer(buffer: PooledBuffer) { this.incoming.push(buffer); diff --git a/sdk/storage/storage-common/src/BuffersStream.ts b/sdk/storage/storage-common/src/BuffersStream.ts index 45cabd17d43d..55755e894cb7 100644 --- a/sdk/storage/storage-common/src/BuffersStream.ts +++ b/sdk/storage/storage-common/src/BuffersStream.ts @@ -10,35 +10,20 @@ export interface BuffersStreamOptions extends ReadableOptions {} /** * This class generates a readable stream from the data in an array of buffers. - * - * @export - * @class BuffersStream */ export class BuffersStream extends Readable { /** * The offset of data to be read in the current buffer. - * - * @private - * @type {number} - * @memberof BuffersStream */ private byteOffsetInCurrentBuffer: number; /** * The index of buffer to be read in the array of buffers. - * - * @private - * @type {number} - * @memberof BuffersStream */ private bufferIndex: number; /** * The total length of data already read. - * - * @private - * @type {number} - * @memberof BuffersStream */ private pushedBytesLength: number; @@ -48,7 +33,6 @@ export class BuffersStream extends Readable { * * @param buffers - Array of buffers containing the data * @param byteLength - The total length of data contained in the buffers - * @memberof BuffersStream */ constructor( private buffers: Buffer[], @@ -74,7 +58,6 @@ export class BuffersStream extends Readable { * Internal _read() that will be called when the stream wants to pull more data in. * * @param size - Optional. The size of data to be read - * @memberof BuffersStream */ public _read(size?: number) { if (this.pushedBytesLength >= this.byteLength) { diff --git a/sdk/storage/storage-common/src/PooledBuffer.ts b/sdk/storage/storage-common/src/PooledBuffer.ts index feb06dc13345..95ada5b4a345 100644 --- a/sdk/storage/storage-common/src/PooledBuffer.ts +++ b/sdk/storage/storage-common/src/PooledBuffer.ts @@ -17,36 +17,21 @@ const maxBufferLength = require("buffer").constants.MAX_LENGTH; * into the internal "buffer" serially with respect to the total length. * Then by calling PooledBuffer.getReadableStream(), you can get a readable stream * assembled from all the data in the internal "buffer". - * - * @export - * @class BufferScheduler */ export class PooledBuffer { /** * Internal buffers used to keep the data. * Each buffer has a length of the maxBufferLength except last one. - * - * @private - * @type {Buffer[]} - * @memberof PooledBuffer */ private buffers: Buffer[] = []; /** * The total size of internal buffers. - * - * @private - * @type {number} - * @memberof PooledBuffer */ private readonly capacity: number; /** * The total size of data contained in internal buffers. - * - * @private - * @type {number} - * @memberof PooledBuffer */ private _size: number; @@ -64,7 +49,6 @@ export class PooledBuffer { * pooled buffer with data. * * @param capacity - Total capacity of the internal buffers - * @memberof PooledBuffer */ constructor(capacity: number); @@ -76,7 +60,6 @@ export class PooledBuffer { * @param capacity - Total capacity of the internal buffers * @param buffers - Input buffers containing the data to be filled in the pooled buffer * @param totalLength - Total length of the data to be filled in. - * @memberof PooledBuffer */ constructor(capacity: number, buffers: Buffer[], totalLength: number); constructor(capacity: number, buffers?: Buffer[], totalLength?: number) { @@ -106,8 +89,6 @@ export class PooledBuffer { * @param buffers - Input buffers containing the data to be filled in the pooled buffer * @param totalLength - Total length of the data to be filled in. * - * - * @memberof PooledBuffer */ public fill(buffers: Buffer[], totalLength: number) { this._size = Math.min(this.capacity, totalLength); @@ -145,8 +126,6 @@ export class PooledBuffer { /** * Get the readable stream assembled from all the data in the internal buffers. * - * - * @memberof PooledBuffer */ public getReadableStream(): Readable { return new BuffersStream(this.buffers, this.size); diff --git a/sdk/storage/storage-datalake/src/dataLakeStorageClient.ts b/sdk/storage/storage-datalake/src/dataLakeStorageClient.ts index ac95fb7fe1a6..fb76774a923f 100644 --- a/sdk/storage/storage-datalake/src/dataLakeStorageClient.ts +++ b/sdk/storage/storage-datalake/src/dataLakeStorageClient.ts @@ -21,8 +21,8 @@ class DataLakeStorageClient extends DataLakeStorageClientContext { /** * Initializes a new instance of the DataLakeStorageClient class. - * @param credentials Credentials needed for the client to connect to Azure. - * @param accountName The Azure Storage account name. + * @param credentials - Credentials needed for the client to connect to Azure. + * @param accountName - The Azure Storage account name. * @param options - The parameter options */ constructor( diff --git a/sdk/storage/storage-datalake/src/dataLakeStorageClientContext.ts b/sdk/storage/storage-datalake/src/dataLakeStorageClientContext.ts index 15e161d7fcf1..6b2b3cfe4bf3 100644 --- a/sdk/storage/storage-datalake/src/dataLakeStorageClientContext.ts +++ b/sdk/storage/storage-datalake/src/dataLakeStorageClientContext.ts @@ -23,8 +23,8 @@ export class DataLakeStorageClientContext extends msRestAzure.AzureServiceClient /** * Initializes a new instance of the DataLakeStorageClient class. - * @param credentials Credentials needed for the client to connect to Azure. - * @param accountName The Azure Storage account name. + * @param credentials - Credentials needed for the client to connect to Azure. + * @param accountName - The Azure Storage account name. * @param options - The parameter options */ constructor( diff --git a/sdk/storage/storage-datalake/src/models/index.ts b/sdk/storage/storage-datalake/src/models/index.ts index c3f2d167cbc6..99e0acf7034e 100644 --- a/sdk/storage/storage-datalake/src/models/index.ts +++ b/sdk/storage/storage-datalake/src/models/index.ts @@ -1471,7 +1471,6 @@ export interface PathDeleteHeaders { /** * @interface * An interface representing the FilesystemList. - * @extends Array */ export interface FilesystemList extends Array { filesystems?: Filesystem[]; @@ -1480,7 +1479,6 @@ export interface FilesystemList extends Array { /** * @interface * An interface representing the PathList. - * @extends Array */ export interface PathList extends Array { paths?: Path[]; @@ -1490,7 +1488,6 @@ export interface PathList extends Array { * Defines values for PathResourceType. * Possible values include: 'directory', 'file' * @readonly - * @enum {string} */ export type PathResourceType = 'directory' | 'file'; @@ -1498,7 +1495,6 @@ export type PathResourceType = 'directory' | 'file'; * Defines values for PathRenameMode. * Possible values include: 'legacy', 'posix' * @readonly - * @enum {string} */ export type PathRenameMode = 'legacy' | 'posix'; @@ -1506,7 +1502,6 @@ export type PathRenameMode = 'legacy' | 'posix'; * Defines values for PathUpdateAction. * Possible values include: 'append', 'flush', 'setProperties', 'setAccessControl' * @readonly - * @enum {string} */ export type PathUpdateAction = 'append' | 'flush' | 'setProperties' | 'setAccessControl'; @@ -1514,7 +1509,6 @@ export type PathUpdateAction = 'append' | 'flush' | 'setProperties' | 'setAccess * Defines values for PathLeaseAction. * Possible values include: 'acquire', 'break', 'change', 'renew', 'release' * @readonly - * @enum {string} */ export type PathLeaseAction = 'acquire' | 'break' | 'change' | 'renew' | 'release'; @@ -1522,7 +1516,6 @@ export type PathLeaseAction = 'acquire' | 'break' | 'change' | 'renew' | 'releas * Defines values for PathGetPropertiesAction. * Possible values include: 'getAccessControl', 'getStatus' * @readonly - * @enum {string} */ export type PathGetPropertiesAction = 'getAccessControl' | 'getStatus'; diff --git a/sdk/storage/storage-datalake/src/operations/filesystemOperations.ts b/sdk/storage/storage-datalake/src/operations/filesystemOperations.ts index d7538ead9bd4..00fce748a3f9 100644 --- a/sdk/storage/storage-datalake/src/operations/filesystemOperations.ts +++ b/sdk/storage/storage-datalake/src/operations/filesystemOperations.ts @@ -34,12 +34,12 @@ export class FilesystemOperations { */ list(options?: Models.FilesystemListOptionalParams): Promise; /** - * @param callback The callback + * @param callback - The callback */ list(callback: msRest.ServiceCallback): void; /** - * @param options The optional parameters - * @param callback The callback + * @param options - The optional parameters + * @param callback - The callback */ list( options: Models.FilesystemListOptionalParams, @@ -62,7 +62,7 @@ export class FilesystemOperations { * Create a filesystem rooted at the specified location. If the filesystem already exists, the * operation fails. This operation does not support conditional HTTP requests. * @summary Create Filesystem - * @param filesystem The filesystem identifier. The value must start and end with a letter or + * @param filesystem - The filesystem identifier. The value must start and end with a letter or * number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes * are not permitted. All letters must be lowercase. The value must have between 3 and 63 * characters. @@ -74,20 +74,20 @@ export class FilesystemOperations { options?: Models.FilesystemCreateOptionalParams ): Promise; /** - * @param filesystem The filesystem identifier. The value must start and end with a letter or + * @param filesystem - The filesystem identifier. The value must start and end with a letter or * number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes * are not permitted. All letters must be lowercase. The value must have between 3 and 63 * characters. - * @param callback The callback + * @param callback - The callback */ create(filesystem: string, callback: msRest.ServiceCallback): void; /** - * @param filesystem The filesystem identifier. The value must start and end with a letter or + * @param filesystem - The filesystem identifier. The value must start and end with a letter or * number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes * are not permitted. All letters must be lowercase. The value must have between 3 and 63 * characters. - * @param options The optional parameters - * @param callback The callback + * @param options - The optional parameters + * @param callback - The callback */ create( filesystem: string, @@ -114,7 +114,7 @@ export class FilesystemOperations { * information, see [Specifying Conditional Headers for Blob Service * Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). * @summary Set Filesystem Properties - * @param filesystem The filesystem identifier. The value must start and end with a letter or + * @param filesystem - The filesystem identifier. The value must start and end with a letter or * number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes * are not permitted. All letters must be lowercase. The value must have between 3 and 63 * characters. @@ -126,20 +126,20 @@ export class FilesystemOperations { options?: Models.FilesystemSetPropertiesOptionalParams ): Promise; /** - * @param filesystem The filesystem identifier. The value must start and end with a letter or + * @param filesystem - The filesystem identifier. The value must start and end with a letter or * number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes * are not permitted. All letters must be lowercase. The value must have between 3 and 63 * characters. - * @param callback The callback + * @param callback - The callback */ setProperties(filesystem: string, callback: msRest.ServiceCallback): void; /** - * @param filesystem The filesystem identifier. The value must start and end with a letter or + * @param filesystem - The filesystem identifier. The value must start and end with a letter or * number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes * are not permitted. All letters must be lowercase. The value must have between 3 and 63 * characters. - * @param options The optional parameters - * @param callback The callback + * @param options - The optional parameters + * @param callback - The callback */ setProperties( filesystem: string, @@ -164,7 +164,7 @@ export class FilesystemOperations { /** * All system and user-defined filesystem properties are specified in the response headers. * @summary Get Filesystem Properties. - * @param filesystem The filesystem identifier. The value must start and end with a letter or + * @param filesystem - The filesystem identifier. The value must start and end with a letter or * number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes * are not permitted. All letters must be lowercase. The value must have between 3 and 63 * characters. @@ -176,20 +176,20 @@ export class FilesystemOperations { options?: Models.FilesystemGetPropertiesOptionalParams ): Promise; /** - * @param filesystem The filesystem identifier. The value must start and end with a letter or + * @param filesystem - The filesystem identifier. The value must start and end with a letter or * number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes * are not permitted. All letters must be lowercase. The value must have between 3 and 63 * characters. - * @param callback The callback + * @param callback - The callback */ getProperties(filesystem: string, callback: msRest.ServiceCallback): void; /** - * @param filesystem The filesystem identifier. The value must start and end with a letter or + * @param filesystem - The filesystem identifier. The value must start and end with a letter or * number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes * are not permitted. All letters must be lowercase. The value must have between 3 and 63 * characters. - * @param options The optional parameters - * @param callback The callback + * @param options - The optional parameters + * @param callback - The callback */ getProperties( filesystem: string, @@ -222,7 +222,7 @@ export class FilesystemOperations { * information, see [Specifying Conditional Headers for Blob Service * Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). * @summary Delete Filesystem - * @param filesystem The filesystem identifier. The value must start and end with a letter or + * @param filesystem - The filesystem identifier. The value must start and end with a letter or * number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes * are not permitted. All letters must be lowercase. The value must have between 3 and 63 * characters. @@ -234,20 +234,20 @@ export class FilesystemOperations { options?: Models.FilesystemDeleteMethodOptionalParams ): Promise; /** - * @param filesystem The filesystem identifier. The value must start and end with a letter or + * @param filesystem - The filesystem identifier. The value must start and end with a letter or * number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes * are not permitted. All letters must be lowercase. The value must have between 3 and 63 * characters. - * @param callback The callback + * @param callback - The callback */ deleteMethod(filesystem: string, callback: msRest.ServiceCallback): void; /** - * @param filesystem The filesystem identifier. The value must start and end with a letter or + * @param filesystem - The filesystem identifier. The value must start and end with a letter or * number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes * are not permitted. All letters must be lowercase. The value must have between 3 and 63 * characters. - * @param options The optional parameters - * @param callback The callback + * @param options - The optional parameters + * @param callback - The callback */ deleteMethod( filesystem: string, diff --git a/sdk/storage/storage-datalake/src/operations/pathOperations.ts b/sdk/storage/storage-datalake/src/operations/pathOperations.ts index c9ea004cd1f1..7c79ac257b01 100644 --- a/sdk/storage/storage-datalake/src/operations/pathOperations.ts +++ b/sdk/storage/storage-datalake/src/operations/pathOperations.ts @@ -29,10 +29,10 @@ export class PathOperations { /** * List filesystem paths and their properties. * @summary List Paths - * @param recursive If "true", all paths are listed; otherwise, only paths at the root of the + * @param recursive - If "true", all paths are listed; otherwise, only paths at the root of the * filesystem are listed. If "directory" is specified, the list will only include paths that share * the same root. - * @param filesystem The filesystem identifier. The value must start and end with a letter or + * @param filesystem - The filesystem identifier. The value must start and end with a letter or * number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes * are not permitted. All letters must be lowercase. The value must have between 3 and 63 * characters. @@ -45,14 +45,14 @@ export class PathOperations { options?: Models.PathListOptionalParams ): Promise; /** - * @param recursive If "true", all paths are listed; otherwise, only paths at the root of the + * @param recursive - If "true", all paths are listed; otherwise, only paths at the root of the * filesystem are listed. If "directory" is specified, the list will only include paths that share * the same root. - * @param filesystem The filesystem identifier. The value must start and end with a letter or + * @param filesystem - The filesystem identifier. The value must start and end with a letter or * number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes * are not permitted. All letters must be lowercase. The value must have between 3 and 63 * characters. - * @param callback The callback + * @param callback - The callback */ list( recursive: boolean, @@ -60,15 +60,15 @@ export class PathOperations { callback: msRest.ServiceCallback ): void; /** - * @param recursive If "true", all paths are listed; otherwise, only paths at the root of the + * @param recursive - If "true", all paths are listed; otherwise, only paths at the root of the * filesystem are listed. If "directory" is specified, the list will only include paths that share * the same root. - * @param filesystem The filesystem identifier. The value must start and end with a letter or + * @param filesystem - The filesystem identifier. The value must start and end with a letter or * number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes * are not permitted. All letters must be lowercase. The value must have between 3 and 63 * characters. - * @param options The optional parameters - * @param callback The callback + * @param options - The optional parameters + * @param callback - The callback */ list( recursive: boolean, @@ -101,8 +101,8 @@ export class PathOperations { * Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). * To fail if the destination already exists, use a conditional request with If-None-Match: "*". * @summary Create File | Create Directory | Rename File | Rename Directory - * @param filesystem The filesystem identifier. - * @param path The file or directory path. + * @param filesystem - The filesystem identifier. + * @param path - The file or directory path. * @param options - The optional parameters * @returns Promise */ @@ -112,16 +112,16 @@ export class PathOperations { options?: Models.PathCreateOptionalParams ): Promise; /** - * @param filesystem The filesystem identifier. - * @param path The file or directory path. - * @param callback The callback + * @param filesystem - The filesystem identifier. + * @param path - The file or directory path. + * @param callback - The callback */ create(filesystem: string, path: string, callback: msRest.ServiceCallback): void; /** - * @param filesystem The filesystem identifier. - * @param path The file or directory path. - * @param options The optional parameters - * @param callback The callback + * @param filesystem - The filesystem identifier. + * @param path - The file or directory path. + * @param options - The optional parameters + * @param callback - The callback */ create( filesystem: string, @@ -153,7 +153,7 @@ export class PathOperations { * information, see [Specifying Conditional Headers for Blob Service * Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). * @summary Append Data | Flush Data | Set Properties | Set Access Control - * @param action The action must be "append" to upload data to be appended to a file, "flush" to + * @param action - The action must be "append" to upload data to be appended to a file, "flush" to * flush previously uploaded data to a file, "setProperties" to set the properties of a file or * directory, or "setAccessControl" to set the owner, group, permissions, or access control list * for a file or directory. Note that Hierarchical Namespace must be enabled for the account in @@ -161,8 +161,8 @@ export class PathOperations { * for the owner, owning group, and others, so the x-ms-permissions and x-ms-acl request headers * are mutually exclusive. Possible values include: 'append', 'flush', 'setProperties', * 'setAccessControl' - * @param filesystem The filesystem identifier. - * @param path The file or directory path. + * @param filesystem - The filesystem identifier. + * @param path - The file or directory path. * @param options - The optional parameters * @returns Promise */ @@ -173,7 +173,7 @@ export class PathOperations { options?: Models.PathUpdateOptionalParams ): Promise; /** - * @param action The action must be "append" to upload data to be appended to a file, "flush" to + * @param action - The action must be "append" to upload data to be appended to a file, "flush" to * flush previously uploaded data to a file, "setProperties" to set the properties of a file or * directory, or "setAccessControl" to set the owner, group, permissions, or access control list * for a file or directory. Note that Hierarchical Namespace must be enabled for the account in @@ -181,9 +181,9 @@ export class PathOperations { * for the owner, owning group, and others, so the x-ms-permissions and x-ms-acl request headers * are mutually exclusive. Possible values include: 'append', 'flush', 'setProperties', * 'setAccessControl' - * @param filesystem The filesystem identifier. - * @param path The file or directory path. - * @param callback The callback + * @param filesystem - The filesystem identifier. + * @param path - The file or directory path. + * @param callback - The callback */ update( action: Models.PathUpdateAction, @@ -192,7 +192,7 @@ export class PathOperations { callback: msRest.ServiceCallback ): void; /** - * @param action The action must be "append" to upload data to be appended to a file, "flush" to + * @param action - The action must be "append" to upload data to be appended to a file, "flush" to * flush previously uploaded data to a file, "setProperties" to set the properties of a file or * directory, or "setAccessControl" to set the owner, group, permissions, or access control list * for a file or directory. Note that Hierarchical Namespace must be enabled for the account in @@ -200,10 +200,10 @@ export class PathOperations { * for the owner, owning group, and others, so the x-ms-permissions and x-ms-acl request headers * are mutually exclusive. Possible values include: 'append', 'flush', 'setProperties', * 'setAccessControl' - * @param filesystem The filesystem identifier. - * @param path The file or directory path. - * @param options The optional parameters - * @param callback The callback + * @param filesystem - The filesystem identifier. + * @param path - The file or directory path. + * @param options - The optional parameters + * @param callback - The callback */ update( action: Models.PathUpdateAction, @@ -237,7 +237,7 @@ export class PathOperations { * for Blob Service * Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). * @summary Lease Path - * @param xMsLeaseAction There are five lease actions: "acquire", "break", "change", "renew", and + * @param xMsLeaseAction - There are five lease actions: "acquire", "break", "change", "renew", and * "release". Use "acquire" and specify the "x-ms-proposed-lease-id" and "x-ms-lease-duration" to * acquire a new lease. Use "break" to break an existing lease. When a lease is broken, the lease * break period is allowed to elapse, during which time no lease operation except break and release @@ -247,8 +247,8 @@ export class PathOperations { * ID of an active lease. Use "renew" and specify the "x-ms-lease-id" to renew an existing lease. * Use "release" and specify the "x-ms-lease-id" to release a lease. Possible values include: * 'acquire', 'break', 'change', 'renew', 'release' - * @param filesystem The filesystem identifier. - * @param path The file or directory path. + * @param filesystem - The filesystem identifier. + * @param path - The file or directory path. * @param options - The optional parameters * @returns Promise */ @@ -259,7 +259,7 @@ export class PathOperations { options?: Models.PathLeaseOptionalParams ): Promise; /** - * @param xMsLeaseAction There are five lease actions: "acquire", "break", "change", "renew", and + * @param xMsLeaseAction - There are five lease actions: "acquire", "break", "change", "renew", and * "release". Use "acquire" and specify the "x-ms-proposed-lease-id" and "x-ms-lease-duration" to * acquire a new lease. Use "break" to break an existing lease. When a lease is broken, the lease * break period is allowed to elapse, during which time no lease operation except break and release @@ -269,9 +269,9 @@ export class PathOperations { * ID of an active lease. Use "renew" and specify the "x-ms-lease-id" to renew an existing lease. * Use "release" and specify the "x-ms-lease-id" to release a lease. Possible values include: * 'acquire', 'break', 'change', 'renew', 'release' - * @param filesystem The filesystem identifier. - * @param path The file or directory path. - * @param callback The callback + * @param filesystem - The filesystem identifier. + * @param path - The file or directory path. + * @param callback - The callback */ lease( xMsLeaseAction: Models.PathLeaseAction, @@ -280,7 +280,7 @@ export class PathOperations { callback: msRest.ServiceCallback ): void; /** - * @param xMsLeaseAction There are five lease actions: "acquire", "break", "change", "renew", and + * @param xMsLeaseAction - There are five lease actions: "acquire", "break", "change", "renew", and * "release". Use "acquire" and specify the "x-ms-proposed-lease-id" and "x-ms-lease-duration" to * acquire a new lease. Use "break" to break an existing lease. When a lease is broken, the lease * break period is allowed to elapse, during which time no lease operation except break and release @@ -290,10 +290,10 @@ export class PathOperations { * ID of an active lease. Use "renew" and specify the "x-ms-lease-id" to renew an existing lease. * Use "release" and specify the "x-ms-lease-id" to release a lease. Possible values include: * 'acquire', 'break', 'change', 'renew', 'release' - * @param filesystem The filesystem identifier. - * @param path The file or directory path. - * @param options The optional parameters - * @param callback The callback + * @param filesystem - The filesystem identifier. + * @param path - The file or directory path. + * @param options - The optional parameters + * @param callback - The callback */ lease( xMsLeaseAction: Models.PathLeaseAction, @@ -327,8 +327,8 @@ export class PathOperations { * for Blob Service * Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). * @summary Read File - * @param filesystem The filesystem identifier. - * @param path The file or directory path. + * @param filesystem - The filesystem identifier. + * @param path - The file or directory path. * @param options - The optional parameters * @returns Promise */ @@ -338,16 +338,16 @@ export class PathOperations { options?: Models.PathReadOptionalParams ): Promise; /** - * @param filesystem The filesystem identifier. - * @param path The file or directory path. - * @param callback The callback + * @param filesystem - The filesystem identifier. + * @param path - The file or directory path. + * @param callback - The callback */ read(filesystem: string, path: string, callback: msRest.ServiceCallback): void; /** - * @param filesystem The filesystem identifier. - * @param path The file or directory path. - * @param options The optional parameters - * @param callback The callback + * @param filesystem - The filesystem identifier. + * @param path - The file or directory path. + * @param options - The optional parameters + * @param callback - The callback */ read( filesystem: string, @@ -379,8 +379,8 @@ export class PathOperations { * [Specifying Conditional Headers for Blob Service * Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). * @summary Get Properties | Get Status | Get Access Control List - * @param filesystem The filesystem identifier. - * @param path The file or directory path. + * @param filesystem - The filesystem identifier. + * @param path - The file or directory path. * @param options - The optional parameters * @returns Promise */ @@ -390,16 +390,16 @@ export class PathOperations { options?: Models.PathGetPropertiesOptionalParams ): Promise; /** - * @param filesystem The filesystem identifier. - * @param path The file or directory path. - * @param callback The callback + * @param filesystem - The filesystem identifier. + * @param path - The file or directory path. + * @param callback - The callback */ getProperties(filesystem: string, path: string, callback: msRest.ServiceCallback): void; /** - * @param filesystem The filesystem identifier. - * @param path The file or directory path. - * @param options The optional parameters - * @param callback The callback + * @param filesystem - The filesystem identifier. + * @param path - The file or directory path. + * @param options - The optional parameters + * @param callback - The callback */ getProperties( filesystem: string, @@ -429,8 +429,8 @@ export class PathOperations { * information, see [Specifying Conditional Headers for Blob Service * Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). * @summary Delete File | Delete Directory - * @param filesystem The filesystem identifier. - * @param path The file or directory path. + * @param filesystem - The filesystem identifier. + * @param path - The file or directory path. * @param options - The optional parameters * @returns Promise */ @@ -440,16 +440,16 @@ export class PathOperations { options?: Models.PathDeleteMethodOptionalParams ): Promise; /** - * @param filesystem The filesystem identifier. - * @param path The file or directory path. - * @param callback The callback + * @param filesystem - The filesystem identifier. + * @param path - The file or directory path. + * @param callback - The callback */ deleteMethod(filesystem: string, path: string, callback: msRest.ServiceCallback): void; /** - * @param filesystem The filesystem identifier. - * @param path The file or directory path. - * @param options The optional parameters - * @param callback The callback + * @param filesystem - The filesystem identifier. + * @param path - The file or directory path. + * @param options - The optional parameters + * @param callback - The callback */ deleteMethod( filesystem: string, diff --git a/sdk/storage/storage-file-datalake/src/DataLakeFileSystemClient.ts b/sdk/storage/storage-file-datalake/src/DataLakeFileSystemClient.ts index 19c24a244e1c..5220acfb6546 100644 --- a/sdk/storage/storage-file-datalake/src/DataLakeFileSystemClient.ts +++ b/sdk/storage/storage-file-datalake/src/DataLakeFileSystemClient.ts @@ -46,27 +46,15 @@ import { generateDataLakeSASQueryParameters } from "./sas/DataLakeSASSignatureVa /** * A DataLakeFileSystemClient represents a URL to the Azure Storage file system * allowing you to manipulate its directories and files. - * - * @export - * @class DataLakeFileSystemClient - * @extends {StorageClient} */ export class DataLakeFileSystemClient extends StorageClient { /** * fileSystemContext provided by protocol layer. - * - * @private - * @type {FileSystemOperations} - * @memberof DataLakeFileSystemClient */ private fileSystemContext: FileSystemOperations; /** - * blobContainerClient provided by @azure/storage-blob package. - * - * @private - * @type {ContainerClient} - * @memberof DataLakeFileSystemClient + * blobContainerClient provided by `@azure/storage-blob` package. */ private blobContainerClient: ContainerClient; @@ -76,9 +64,8 @@ export class DataLakeFileSystemClient extends StorageClient { * @param url - A Client string pointing to Azure Storage data lake file system, such as * "https://myaccount.dfs.core.windows.net/filesystem". You can append a SAS * if using AnonymousCredential, such as "https://myaccount.dfs.core.windows.net/filesystem?sasString". - * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. + * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. * @param options - Optional. Options to configure the HTTP pipeline. - * @memberof DataLakeFileSystemClient */ constructor( url: string, @@ -94,7 +81,6 @@ export class DataLakeFileSystemClient extends StorageClient { * if using AnonymousCredential, such as "https://myaccount.dfs.core.windows.net/filesystem?sasString". * @param pipeline - Call newPipeline() to create a default * pipeline, or provide a customized pipeline. - * @memberof DataLakeFileSystemClient */ constructor(url: string, pipeline: Pipeline); @@ -129,8 +115,6 @@ export class DataLakeFileSystemClient extends StorageClient { * Name of current file system. * * @readonly - * @type {string} - * @memberof DataLakeFileSystemClient */ public get name(): string { return this.blobContainerClient.containerName; @@ -140,8 +124,6 @@ export class DataLakeFileSystemClient extends StorageClient { * Creates a {@link DataLakeDirectoryClient} object under current file system. * * @param directoryName - - * - * @memberof DataLakeFileSystemClient */ public getDirectoryClient(directoryName: string): DataLakeDirectoryClient { return new DataLakeDirectoryClient( @@ -154,8 +136,6 @@ export class DataLakeFileSystemClient extends StorageClient { * Creates a {@link DataLakeFileClient} object under current file system. * * @param fileName - - * - * @memberof DataLakeFileSystemClient */ public getFileClient(fileName: string): DataLakeFileClient { return new DataLakeFileClient( @@ -168,8 +148,6 @@ export class DataLakeFileSystemClient extends StorageClient { * Get a {@link DataLakeLeaseClient} that manages leases on the file system. * * @param proposeLeaseId - Optional. Initial proposed lease Id. - * - * @memberof DataLakeFileSystemClient */ public getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient { return new DataLakeLeaseClient(this.blobContainerClient.getBlobLeaseClient(proposeLeaseId)); @@ -182,8 +160,6 @@ export class DataLakeFileSystemClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-container * * @param options - Optional. Options when creating file system. - * - * @memberof DataLakeFileSystemClient */ public async create(options: FileSystemCreateOptions = {}): Promise { const { span, spanOptions } = createSpan( @@ -214,8 +190,6 @@ export class DataLakeFileSystemClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-container * * @param options - - * - * @memberof DataLakeFileSystemClient */ public async createIfNotExists( options: FileSystemCreateOptions = {} @@ -249,8 +223,6 @@ export class DataLakeFileSystemClient extends StorageClient { * applications after this function completes. * * @param options - - * - * @memberof DataLakeFileSystemClient */ public async exists(options: FileSystemExistsOptions = {}): Promise { const { span, spanOptions } = createSpan( @@ -279,8 +251,6 @@ export class DataLakeFileSystemClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container * * @param options - Optional. Options when deleting file system. - * - * @memberof DataLakeFileSystemClient */ public async delete(options: FileSystemDeleteOptions = {}): Promise { const { span, spanOptions } = createSpan( @@ -309,8 +279,6 @@ export class DataLakeFileSystemClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container * * @param options - - * - * @memberof DataLakeFileSystemClient */ public async deleteIfExists( options: FileSystemDeleteOptions = {} @@ -347,8 +315,6 @@ export class DataLakeFileSystemClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties * * @param options - Optional. Options when getting file system properties. - * - * @memberof DataLakeFileSystemClient */ public async getProperties( options: FileSystemGetPropertiesOptions = {} @@ -395,8 +361,6 @@ export class DataLakeFileSystemClient extends StorageClient { * @param metadata - Replace existing metadata with this value. * If no value provided the existing metadata will be removed. * @param options - Optional. Options when setting file system metadata. - * - * @memberof DataLakeFileSystemClient */ public async setMetadata( metadata?: Metadata, @@ -432,8 +396,6 @@ export class DataLakeFileSystemClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl * * @param options - Optional. Options when getting file system access policy. - * - * @memberof DataLakeFileSystemClient */ public async getAccessPolicy( options: FileSystemGetAccessPolicyOptions = {} @@ -482,8 +444,6 @@ export class DataLakeFileSystemClient extends StorageClient { * @param access - Optional. The level of public access to data in the file system. * @param fileSystemAcl - Optional. Array of elements each having a unique Id and details of the access policy. * @param options - Optional. Options when setting file system access policy. - * - * @memberof DataLakeFileSystemClient */ public async setAccessPolicy( access?: PublicAccessType, @@ -584,8 +544,6 @@ export class DataLakeFileSystemClient extends StorageClient { * @see https://docs.microsoft.com/rest/api/storageservices/list-blobs * * @param options - Optional. Options when listing paths. - * - * @memberof DataLakeFileSystemClient */ public listPaths( options: ListPathsOptions = {} @@ -677,7 +635,6 @@ export class DataLakeFileSystemClient extends StorageClient { * * @param options - Optional parameters. * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token. - * @memberof DataLakeFileSystemClient */ public generateSasUrl(options: FileSystemGenerateSasUrlOptions): Promise { return new Promise((resolve) => { diff --git a/sdk/storage/storage-file-datalake/src/DataLakeServiceClient.ts b/sdk/storage/storage-file-datalake/src/DataLakeServiceClient.ts index ca7a453b7751..4473a042cb0e 100644 --- a/sdk/storage/storage-file-datalake/src/DataLakeServiceClient.ts +++ b/sdk/storage/storage-file-datalake/src/DataLakeServiceClient.ts @@ -39,20 +39,12 @@ import { AccountSASServices } from "./sas/AccountSASServices"; * DataLakeServiceClient allows you to manipulate Azure * Data Lake service resources and file systems. The storage account provides * the top-level namespace for the Data Lake service. - * - * @export - * @class DataLakeServiceClient - * @extends {StorageClient} */ export class DataLakeServiceClient extends StorageClient { // private serviceContext: Service; /** - * blobServiceClient provided by @azure/storage-blob package. - * - * @private - * @type {BlobServiceClient} - * @memberof DataLakeServiceClient + * blobServiceClient provided by `@azure/storage-blob` package. */ private blobServiceClient: BlobServiceClient; @@ -67,7 +59,6 @@ export class DataLakeServiceClient extends StorageClient { * SAS connection string example - * `BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString` * @param options - Optional. Options to configure the HTTP pipeline. - * @memberof DataLakeServiceClient */ public static fromConnectionString(connectionString: string, options?: StoragePipelineOptions) { options = options || {}; @@ -103,9 +94,8 @@ export class DataLakeServiceClient extends StorageClient { * @param url - A Client string pointing to Azure Storage data lake service, such as * "https://myaccount.dfs.core.windows.net". You can append a SAS * if using AnonymousCredential, such as "https://myaccount.dfs.core.windows.net?sasString". - * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. + * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. * @param options - Optional. Options to configure the HTTP pipeline. - * @memberof DataLakeServiceClient */ public constructor( url: string, @@ -121,7 +111,6 @@ export class DataLakeServiceClient extends StorageClient { * if using AnonymousCredential, such as "https://myaccount.dfs.core.windows.net?sasString". * @param pipeline - Call newPipeline() to create a default * pipeline, or provide a customized pipeline. - * @memberof DataLakeServiceClient */ public constructor(url: string, pipeline: Pipeline); @@ -156,8 +145,6 @@ export class DataLakeServiceClient extends StorageClient { * Creates a {@link DataLakeFileSystemClient} object. * * @param fileSystemName - File system name. - * - * @memberof DataLakeServiceClient */ public getFileSystemClient(fileSystemName: string): DataLakeFileSystemClient { return new DataLakeFileSystemClient( @@ -183,7 +170,7 @@ export class DataLakeServiceClient extends StorageClient { * expiresOn, // Optional. Date type * ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional * protocol: SASProtocol.HttpsAndHttp, // Optional - * version: "2018-11-09" // Must >= 2018-11-09 to generate user delegation SAS + * version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS * }, * userDelegationKey, // UserDelegationKey * accountName @@ -194,8 +181,6 @@ export class DataLakeServiceClient extends StorageClient { * @param startsOn - The start time for the user delegation SAS. Must be within 7 days of the current time. * @param expiresOn - The end time for the user delegation SAS. Must be within 7 days of the current time. * @param options - - * - * @memberof DataLakeServiceClient */ public async getUserDelegationKey( startsOn: Date, @@ -299,8 +284,6 @@ export class DataLakeServiceClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/list-containers2 * * @param options - - * - * @memberof DataLakeServiceClient */ public listFileSystems( options: ServiceListFileSystemsOptions = {} @@ -329,7 +312,6 @@ export class DataLakeServiceClient extends StorageClient { * @param resourceTypes - Specifies the resource types associated with the shared access signature. * @param options - Optional parameters. * @returns An account SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token. - * @memberof DataLakeServiceClient */ public generateAccountSasUrl( expiresOn?: Date, @@ -368,7 +350,6 @@ export class DataLakeServiceClient extends StorageClient { * @param sourceFileSystemName - The name of the source File System. * @param destinationContainerName - The new name of the File System. * @param options - Options to configure File System Rename operation. - * @memberof DataLakeServiceClient */ // @ts-ignore Need to hide this interface for now. Make it public and turn on the live tests for it when the service is ready. private async renameFileSystem( @@ -417,7 +398,6 @@ export class DataLakeServiceClient extends StorageClient { * @param deletedFileSystemName - The name of the source File System. * @param deleteFileSystemVersion - The new name of the File System. * @param options - Options to configure File System Restore operation. - * @memberof DataLakeServiceClient */ public async undeleteFileSystem( deletedFileSystemName: string, diff --git a/sdk/storage/storage-file-datalake/src/Pipeline.ts b/sdk/storage/storage-file-datalake/src/Pipeline.ts index 063ef9301e98..e25a50898f35 100644 --- a/sdk/storage/storage-file-datalake/src/Pipeline.ts +++ b/sdk/storage/storage-file-datalake/src/Pipeline.ts @@ -63,16 +63,10 @@ export { /** * Option interface for Pipeline constructor. - * - * @export - * @interface PipelineOptions */ export interface PipelineOptions { /** * Optional. Configures the HTTP client to send requests and receive responses. - * - * @type {IHttpClient} - * @memberof PipelineOptions */ httpClient?: IHttpClient; } @@ -84,23 +78,14 @@ export interface PipelineOptions { * * Refer to {@link newPipeline} and provided policies before implementing your * customized Pipeline. - * - * @export - * @class Pipeline */ export class Pipeline extends BlobPipeline { /** * A list of chained request policy factories. - * - * @type {RequestPolicyFactory[]} - * @memberof Pipeline */ public readonly factories: RequestPolicyFactory[]; /** * Configures pipeline logger and HTTP client. - * - * @type {PipelineOptions} - * @memberof Pipeline */ public readonly options: PipelineOptions; @@ -109,7 +94,6 @@ export class Pipeline extends BlobPipeline { * * @param factories - * @param options - - * @memberof Pipeline */ constructor(factories: RequestPolicyFactory[], options: PipelineOptions = {}) { super(factories, options); @@ -127,7 +111,6 @@ export class Pipeline extends BlobPipeline { * ServiceClient constructor. * * @returns The ServiceClientOptions object from this Pipeline. - * @memberof Pipeline */ public toServiceClientOptions(): ServiceClientOptions { return { @@ -139,9 +122,6 @@ export class Pipeline extends BlobPipeline { /** * Options interface for the {@link newPipeline} function. - * - * @export - * @interface StoragePipelineOptions */ export interface StoragePipelineOptions { /** @@ -150,31 +130,19 @@ export interface StoragePipelineOptions { proxyOptions?: ProxyOptions; /** * Options for adding user agent details to outgoing requests. - * - * @type {UserAgentOptions} - * @memberof StoragePipelineOptions */ userAgentOptions?: UserAgentOptions; /** * Configures the built-in retry policy behavior. - * - * @type {StorageRetryOptions} - * @memberof StoragePipelineOptions */ retryOptions?: StorageRetryOptions; /** * Keep alive configurations. Default keep-alive is enabled. - * - * @type {KeepAliveOptions} - * @memberof StoragePipelineOptions */ keepAliveOptions?: KeepAliveOptions; /** * Configures the HTTP client to send requests and receive responses. - * - * @type {IHttpClient} - * @memberof StoragePipelineOptions */ httpClient?: IHttpClient; } @@ -182,8 +150,7 @@ export interface StoragePipelineOptions { /** * Creates a new Pipeline object with Credential provided. * - * @export - * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. + * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. * @param pipelineOptions - Optional. Options. * @returns A new Pipeline object. */ @@ -234,10 +201,8 @@ export function newPipeline( /** * Attach a TokenCredential to an object. * - * @export * @param thing - * @param credential - - * */ function attachCredential(thing: T, credential: TokenCredential): T { (thing as any).credential = credential; diff --git a/sdk/storage/storage-file-datalake/src/StorageBrowserPolicyFactory.ts b/sdk/storage/storage-file-datalake/src/StorageBrowserPolicyFactory.ts index 0fa7ac675b09..9a7c4b614ced 100644 --- a/sdk/storage/storage-file-datalake/src/StorageBrowserPolicyFactory.ts +++ b/sdk/storage/storage-file-datalake/src/StorageBrowserPolicyFactory.ts @@ -7,10 +7,6 @@ export { StorageBrowserPolicy }; /** * StorageBrowserPolicyFactory is a factory class helping generating StorageBrowserPolicy objects. - * - * @export - * @class StorageBrowserPolicyFactory - * @implements {RequestPolicyFactory} */ export class StorageBrowserPolicyFactory implements RequestPolicyFactory { /** @@ -18,8 +14,6 @@ export class StorageBrowserPolicyFactory implements RequestPolicyFactory { * * @param nextPolicy - * @param options - - * - * @memberof StorageBrowserPolicyFactory */ public create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageBrowserPolicy { return new StorageBrowserPolicy(nextPolicy, options); diff --git a/sdk/storage/storage-file-datalake/src/StorageClient.ts b/sdk/storage/storage-file-datalake/src/StorageClient.ts index bc7ba6f27e52..ddfd6337e51b 100644 --- a/sdk/storage/storage-file-datalake/src/StorageClient.ts +++ b/sdk/storage/storage-file-datalake/src/StorageClient.ts @@ -23,16 +23,10 @@ export interface CommonOptions { /** * A StorageClient represents a based URL class for {@link BlobServiceClient}, {@link ContainerClient} * and etc. - * - * @export - * @class StorageClient */ export abstract class StorageClient { /** * Encoded URL string value. - * - * @type {string} - * @memberof StorageClient */ public readonly url: string; @@ -40,17 +34,11 @@ export abstract class StorageClient { /** * Encoded URL string value for corresponding blob endpoint. - * - * @type {string} - * @memberof StorageClient */ protected readonly blobEndpointUrl: string; /** * Encoded URL string value for corresponding dfs endpoint. - * - * @type {string} - * @memberof StorageClient */ protected readonly dfsEndpointUrl: string; @@ -58,44 +46,27 @@ export abstract class StorageClient { * Request policy pipeline. * * @internal - * @hidden - * @type {Pipeline} - * @memberof StorageClient */ protected readonly pipeline: Pipeline; /** - * Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. - * - * @type {StorageSharedKeyCredential | AnonymousCredential | TokenCredential} - * @memberof StorageClient + * Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. */ public readonly credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential; /** * StorageClient is a reference to protocol layer operations entry, which is * generated by AutoRest generator. - * - * @protected - * @type {StorageClientContext} - * @memberof StorageClient */ protected readonly storageClientContext: StorageClientContext; /** * storageClientContextWithBlobEndpoint is a reference to protocol layer operations entry, which is * generated by AutoRest generator, with its url pointing to the Blob endpoint. - * - * @protected - * @type {StorageClientContext} - * @memberof StorageClient */ protected readonly storageClientContextToBlobEndpoint: StorageClientContext; /** - * @protected - * @type {boolean} - * @memberof StorageClient */ protected readonly isHttps: boolean; @@ -103,7 +74,6 @@ export abstract class StorageClient { * Creates an instance of StorageClient. * @param url - url to resource * @param pipeline - request policy pipeline. - * @memberof StorageClient */ protected constructor(url: string, pipeline: Pipeline) { // URL should be encoded and only once, protocol layer shouldn't encode URL again diff --git a/sdk/storage/storage-file-datalake/src/StorageRetryPolicyFactory.ts b/sdk/storage/storage-file-datalake/src/StorageRetryPolicyFactory.ts index 4ab544371756..fbd217bf7048 100644 --- a/sdk/storage/storage-file-datalake/src/StorageRetryPolicyFactory.ts +++ b/sdk/storage/storage-file-datalake/src/StorageRetryPolicyFactory.ts @@ -8,16 +8,10 @@ export { StorageRetryPolicyType, StorageRetryPolicy }; /** * Storage Blob retry options interface. - * - * @export - * @interface StorageRetryOptions */ export interface StorageRetryOptions { /** * Optional. StorageRetryPolicyType, default is exponential retry policy. - * - * @type {StorageRetryPolicyType} - * @memberof StorageRetryOptions */ readonly retryPolicyType?: StorageRetryPolicyType; @@ -25,9 +19,6 @@ export interface StorageRetryOptions { * Optional. Max try number of attempts, default is 4. * A value of 1 means 1 try and no retries. * A value smaller than 1 means default retry number of attempts. - * - * @type {number} - * @memberof StorageRetryOptions */ readonly maxTries?: number; @@ -37,9 +28,6 @@ export interface StorageRetryOptions { * Storage server's default timeout policy will be used. * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-blob-service-operations - * - * @type {number} - * @memberof StorageRetryOptions */ readonly tryTimeoutInMs?: number; @@ -47,18 +35,12 @@ export interface StorageRetryOptions { * Optional. Specifies the amount of delay to use before retrying an operation (default is 4s or 4 * 1000ms). * The delay increases (exponentially or linearly) with each retry up to a maximum specified by * maxRetryDelayInMs. If you specify 0, then you must also specify 0 for maxRetryDelayInMs. - * - * @type {number} - * @memberof StorageRetryOptions */ readonly retryDelayInMs?: number; /** * Optional. Specifies the maximum delay allowed before retrying an operation (default is 120s or 120 * 1000ms). * If you specify 0, then you must also specify 0 for retryDelayInMs. - * - * @type {number} - * @memberof StorageRetryOptions */ readonly maxRetryDelayInMs?: number; @@ -69,19 +51,12 @@ export interface StorageRetryOptions { * NOTE: Before setting this field, make sure you understand the issues around * reading stale and potentially-inconsistent data at * {@link https://docs.microsoft.com/en-us/azure/storage/common/storage-designing-ha-apps-with-ragrs} - * - * @type {string} - * @memberof StorageRetryOptions */ readonly secondaryHost?: string; } /** * StorageRetryPolicyFactory is a factory class helping generating {@link StorageRetryPolicy} objects. - * - * @export - * @class StorageRetryPolicyFactory - * @implements {RequestPolicyFactory} */ export class StorageRetryPolicyFactory implements RequestPolicyFactory { private retryOptions?: StorageRetryOptions; @@ -89,7 +64,6 @@ export class StorageRetryPolicyFactory implements RequestPolicyFactory { /** * Creates an instance of StorageRetryPolicyFactory. * @param retryOptions - - * @memberof StorageRetryPolicyFactory */ constructor(retryOptions?: StorageRetryOptions) { this.retryOptions = retryOptions; @@ -100,8 +74,6 @@ export class StorageRetryPolicyFactory implements RequestPolicyFactory { * * @param nextPolicy - * @param options - - * - * @memberof StorageRetryPolicyFactory */ public create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageRetryPolicy { return new StorageRetryPolicy(nextPolicy, options, this.retryOptions); diff --git a/sdk/storage/storage-file-datalake/src/TelemetryPolicyFactory.ts b/sdk/storage/storage-file-datalake/src/TelemetryPolicyFactory.ts index 6318c7f1f929..884d89e48406 100644 --- a/sdk/storage/storage-file-datalake/src/TelemetryPolicyFactory.ts +++ b/sdk/storage/storage-file-datalake/src/TelemetryPolicyFactory.ts @@ -15,22 +15,16 @@ import { SDK_VERSION } from "./utils/constants"; /** * TelemetryPolicyFactory is a factory class helping generating {@link TelemetryPolicy} objects. - * - * @export - * @class TelemetryPolicyFactory - * @implements {RequestPolicyFactory} */ export class TelemetryPolicyFactory implements RequestPolicyFactory { /** * @internal - * @hidden */ public readonly telemetryString: string; /** * Creates an instance of TelemetryPolicyFactory. * @param telemetry - - * @memberof TelemetryPolicyFactory */ constructor(telemetry?: UserAgentOptions) { const userAgentInfo: string[] = []; @@ -64,8 +58,6 @@ export class TelemetryPolicyFactory implements RequestPolicyFactory { * * @param nextPolicy - * @param options - - * - * @memberof TelemetryPolicyFactory */ public create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): TelemetryPolicy { return new TelemetryPolicy(nextPolicy, options, this.telemetryString); diff --git a/sdk/storage/storage-file-datalake/src/clients.ts b/sdk/storage/storage-file-datalake/src/clients.ts index b983337f3a3c..e9ff8b5fb3b5 100644 --- a/sdk/storage/storage-file-datalake/src/clients.ts +++ b/sdk/storage/storage-file-datalake/src/clients.ts @@ -100,41 +100,26 @@ import { fsCreateReadStream, fsStat } from "./utils/utils.node"; /** * A DataLakePathClient represents a URL to the Azure Storage path (directory or file). - * - * @export - * @class DataLakePathClient - * @extends {StorageClient} */ export class DataLakePathClient extends StorageClient { /** * pathContext provided by protocol layer. - * - * @private - * @type {PathOperations} - * @memberof DataLakePathClient */ private pathContext: PathOperations; /** - * blobClient provided by @azure/storage-blob package. - * - * @private - * @type {BlobClient} - * @memberof DataLakePathClient + * blobClient provided by `@azure/storage-blob` package. */ private blobClient: BlobClient; /** * SetAccessControlRecursiveInternal operation sets the Access Control on a path and sub paths. * - * @private * @param mode - Mode \"set\" sets POSIX access control rights on files and directories, * Mode \"modify\" modifies one or more POSIX access control rights that pre-exist on files and directories, * Mode \"remove\" removes one or more POSIX access control rights that were present earlier on files and directories. * @param acl - The POSIX access control list for the file or directory. * @param options - Optional. Options - * - * @memberof DataLakePathClient */ private async setAccessControlRecursiveInternal( mode: PathSetAccessControlRecursiveMode, @@ -228,9 +213,8 @@ export class DataLakePathClient extends StorageClient { * @param url - A Client string pointing to Azure Storage data lake path (directory or file), such as * "https://myaccount.dfs.core.windows.net/filesystem/directory" or "https://myaccount.dfs.core.windows.net/filesystem/file". * You can append a SAS if using AnonymousCredential, such as "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString". - * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. + * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. * @param options - Optional. Options to configure the HTTP pipeline. - * @memberof DataLakePathClient */ public constructor( url: string, @@ -246,7 +230,6 @@ export class DataLakePathClient extends StorageClient { * You can append a SAS if using AnonymousCredential, such as "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString". * @param pipeline - Call newPipeline() to create a default * pipeline, or provide a customized pipeline. - * @memberof DataLakePathClient */ public constructor(url: string, pipeline: Pipeline); @@ -281,8 +264,6 @@ export class DataLakePathClient extends StorageClient { * Name of current file system. * * @readonly - * @type {string} - * @memberof DataLakePathClient */ public get fileSystemName(): string { return this.blobClient.containerName; @@ -292,8 +273,6 @@ export class DataLakePathClient extends StorageClient { * Name of current path (directory or file). * * @readonly - * @type {string} - * @memberof DataLakePathClient */ public get name(): string { return this.blobClient.name; @@ -302,8 +281,6 @@ export class DataLakePathClient extends StorageClient { /** * Convert current DataLakePathClient to DataLakeDirectoryClient if current path is a directory. * - * - * @memberof DataLakePathClient */ public toDirectoryClient(): DataLakeDirectoryClient { return new DataLakeDirectoryClient(this.dfsEndpointUrl, this.pipeline); @@ -312,8 +289,6 @@ export class DataLakePathClient extends StorageClient { /** * Convert current DataLakePathClient to DataLakeFileClient if current path is a file. * - * - * @memberof DataLakePathClient */ public toFileClient(): DataLakeFileClient { return new DataLakeFileClient(this.dfsEndpointUrl, this.pipeline); @@ -323,8 +298,6 @@ export class DataLakePathClient extends StorageClient { * Get a {@link DataLakeLeaseClient} that manages leases on the path (directory or file). * * @param proposeLeaseId - Optional. Initial proposed lease Id. - * - * @memberof DataLakePathClient */ public getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient { return new DataLakeLeaseClient(this.blobClient.getBlobLeaseClient(proposeLeaseId)); @@ -337,8 +310,6 @@ export class DataLakePathClient extends StorageClient { * * @param resourceType - Resource type, "directory" or "file". * @param options - Optional. Options when creating path. - * - * @memberof DataLakePathClient */ public async create( resourceType: PathResourceTypeModel, @@ -373,8 +344,6 @@ export class DataLakePathClient extends StorageClient { * * @param resourceType - Resource type, "directory" or "file". * @param options - - * - * @memberof DataLakePathClient */ public async createIfNotExists( resourceType: PathResourceTypeModel, @@ -425,8 +394,6 @@ export class DataLakePathClient extends StorageClient { * function completes. * * @param options - options to Exists operation. - * - * @memberof DataLakePathClient */ public async exists(options: PathExistsOptions = {}): Promise { const { span, spanOptions } = createSpan("DataLakeFileClient-exists", options.tracingOptions); @@ -453,8 +420,6 @@ export class DataLakePathClient extends StorageClient { * * @param recursive - Required and valid only when the resource is a directory. If "true", all paths beneath the directory will be deleted. * @param options - Optional. Options when deleting path. - * - * @memberof DataLakePathClient */ public async delete( recursive?: boolean, @@ -498,8 +463,6 @@ export class DataLakePathClient extends StorageClient { * * @param recursive - Required and valid only when the resource is a directory. If "true", all paths beneath the directory will be deleted. * @param options - - * - * @memberof DataLakePathClient */ public async deleteIfExists( recursive?: boolean, @@ -547,8 +510,6 @@ export class DataLakePathClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties * * @param options - Optional. Options when getting file access control. - * - * @memberof DataLakePathClient */ public async getAccessControl( options: PathGetAccessControlOptions = {} @@ -586,8 +547,6 @@ export class DataLakePathClient extends StorageClient { * * @param acl - The POSIX access control list for the file or directory. * @param options - Optional. Options when setting path access control. - * - * @memberof DataLakePathClient */ public async setAccessControl( acl: PathAccessControlItem[], @@ -624,8 +583,6 @@ export class DataLakePathClient extends StorageClient { * * @param acl - The POSIX access control list for the file or directory. * @param options - Optional. Options - * - * @memberof DataLakePathClient */ public async setAccessControlRecursive( acl: PathAccessControlItem[], @@ -658,8 +615,6 @@ export class DataLakePathClient extends StorageClient { * * @param acl - The POSIX access control list for the file or directory. * @param options - Optional. Options - * - * @memberof DataLakePathClient */ public async updateAccessControlRecursive( acl: PathAccessControlItem[], @@ -692,8 +647,6 @@ export class DataLakePathClient extends StorageClient { * * @param acl - The POSIX access control list for the file or directory. * @param options - Optional. Options - * - * @memberof DataLakePathClient */ public async removeAccessControlRecursive( acl: RemovePathAccessControlItem[], @@ -726,8 +679,6 @@ export class DataLakePathClient extends StorageClient { * * @param permissions - The POSIX access permissions for the file owner, the file owning group, and others. * @param options - Optional. Options when setting path permissions. - * - * @memberof DataLakePathClient */ public async setPermissions( permissions: PathPermissions, @@ -769,8 +720,6 @@ export class DataLakePathClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties * * @param options - Optional. Options when getting path properties. - * - * @memberof DataLakePathClient */ public async getProperties( options: PathGetPropertiesOptions = {} @@ -805,8 +754,6 @@ export class DataLakePathClient extends StorageClient { * * @param httpHeaders - * @param options - - * - * @memberof DataLakePathClient */ public async setHttpHeaders( httpHeaders: PathHttpHeaders, @@ -853,8 +800,6 @@ export class DataLakePathClient extends StorageClient { * @param metadata - Optional. Replace existing metadata with this value. * If no value provided the existing metadata will be removed. * @param options - Optional. Options when setting path metadata. - * - * @memberof DataLakePathClient */ public async setMetadata( metadata?: Metadata, @@ -889,8 +834,6 @@ export class DataLakePathClient extends StorageClient { * @param destinationPath - Destination directory path like "directory" or file path "directory/file". * If the destinationPath is authenticated with SAS, add the SAS to the destination path like "directory/file?sasToken". * @param options - Optional. Options when moving directory or file. - * - * @memberof DataLakePathClient */ public async move(destinationPath: string, options?: PathMoveOptions): Promise; @@ -903,8 +846,6 @@ export class DataLakePathClient extends StorageClient { * @param destinationPath - Destination directory path like "directory" or file path "directory/file" * If the destinationPath is authenticated with SAS, add the SAS to the destination path like "directory/file?sasToken". * @param options - Optional. Options when moving directory or file. - * - * @memberof DataLakePathClient */ public async move( destinationFileSystem: string, @@ -980,10 +921,6 @@ export class DataLakePathClient extends StorageClient { /** * A DataLakeDirectoryClient represents a URL to the Azure Storage directory. - * - * @export - * @class DataLakeDirectoryClient - * @extends {DataLakePathClient} */ export class DataLakeDirectoryClient extends DataLakePathClient { // https://stackoverflow.com/questions/50729485/override-method-with-different-argument-types-in-extended-class-typescript @@ -994,8 +931,6 @@ export class DataLakeDirectoryClient extends DataLakePathClient { * * @param resourceType - Resource type, must be "directory" for DataLakeDirectoryClient. * @param options - Optional. Options when creating directory. - * - * @memberof DataLakeDirectoryClient */ public async create( resourceType: PathResourceTypeModel, @@ -1008,8 +943,6 @@ export class DataLakeDirectoryClient extends DataLakePathClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create * * @param options - Optional. Options when creating directory. - * - * @memberof DataLakeDirectoryClient */ public async create(options?: DirectoryCreateOptions): Promise; @@ -1059,8 +992,6 @@ export class DataLakeDirectoryClient extends DataLakePathClient { * * @param resourceType - Resource type, must be "directory" for DataLakeDirectoryClient. * @param options - - * - * @memberof DataLakeDirectoryClient */ public async createIfNotExists( resourceType: PathResourceTypeModel, @@ -1073,8 +1004,6 @@ export class DataLakeDirectoryClient extends DataLakePathClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create * * @param options - - * - * @memberof DataLakeDirectoryClient */ public async createIfNotExists( options?: DirectoryCreateIfNotExistsOptions @@ -1121,8 +1050,6 @@ export class DataLakeDirectoryClient extends DataLakePathClient { * Creates a {@link DataLakeDirectoryClient} object under current directory. * * @param subdirectoryName - Subdirectory name. - * - * @memberof DataLakeDirectoryClient */ public getSubdirectoryClient(subdirectoryName: string): DataLakeDirectoryClient { return new DataLakeDirectoryClient( @@ -1135,8 +1062,6 @@ export class DataLakeDirectoryClient extends DataLakePathClient { * Creates a {@link DataLakeFileClient} object under current directory. * * @param fileName - - * - * @memberof DataLakeDirectoryClient */ public getFileClient(fileName: string): DataLakeFileClient { return new DataLakeFileClient( @@ -1155,7 +1080,6 @@ export class DataLakeDirectoryClient extends DataLakePathClient { * * @param options - Optional parameters. * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token. - * @memberof DataLakeDirectoryClient */ public generateSasUrl(options: DirectoryGenerateSasUrlOptions): Promise { return new Promise((resolve) => { @@ -1182,36 +1106,20 @@ export class DataLakeDirectoryClient extends DataLakePathClient { /** * A DataLakeFileClient represents a URL to the Azure Storage file. - * - * @export - * @class DataLakeFileClient - * @extends {DataLakePathClient} */ export class DataLakeFileClient extends DataLakePathClient { /** * pathContextInternal provided by protocol layer. - * - * @private - * @type {PathOperations} - * @memberof DataLakeFileClient */ private pathContextInternal: PathOperations; /** * pathContextInternal provided by protocol layer, with its url pointing to the Blob endpoint. - * - * @private - * @type {PathOperations} - * @memberof DataLakeFileClient */ private pathContextInternalToBlobEndpoint: PathOperations; /** - * blockBlobClientInternal provided by @azure/storage-blob package. - * - * @private - * @type {BlockBlobClient} - * @memberof DataLakeFileClient + * blockBlobClientInternal provided by `@azure/storage-blob` package. */ private blockBlobClientInternal: BlockBlobClient; @@ -1221,9 +1129,8 @@ export class DataLakeFileClient extends DataLakePathClient { * @param url - A Client string pointing to Azure Storage data lake file, such as * "https://myaccount.dfs.core.windows.net/filesystem/file". * You can append a SAS if using AnonymousCredential, such as "https://myaccount.dfs.core.windows.net/filesystem/directory/file?sasString". - * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. + * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. * @param options - Optional. Options to configure the HTTP pipeline. - * @memberof DataLakeFileClient */ public constructor( url: string, @@ -1239,7 +1146,6 @@ export class DataLakeFileClient extends DataLakePathClient { * You can append a SAS if using AnonymousCredential, such as "https://myaccount.dfs.core.windows.net/filesystem/directory/file?sasString". * @param pipeline - Call newPipeline() to create a default * pipeline, or provide a customized pipeline. - * @memberof DataLakeFileClient */ public constructor(url: string, pipeline: Pipeline); @@ -1280,8 +1186,6 @@ export class DataLakeFileClient extends DataLakePathClient { * * @param resourceType - Resource type, must be "file" for DataLakeFileClient. * @param options - Optional. Options when creating file. - * - * @memberof DataLakeFileClient */ public async create( resourceType: PathResourceTypeModel, @@ -1294,8 +1198,6 @@ export class DataLakeFileClient extends DataLakePathClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create * * @param options - Optional. Options when creating file. - * - * @memberof DataLakeFileClient */ public async create(options?: FileCreateOptions): Promise; @@ -1342,8 +1244,6 @@ export class DataLakeFileClient extends DataLakePathClient { * * @param resourceType - Resource type, must be "file" for DataLakeFileClient. * @param options - - * - * @memberof DataLakeFileClient */ public async createIfNotExists( resourceType: PathResourceTypeModel, @@ -1356,8 +1256,6 @@ export class DataLakeFileClient extends DataLakePathClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create * * @param options - Optional. Options when creating file. - * - * @memberof DataLakeFileClient */ public async createIfNotExists( options?: FileCreateIfNotExistsOptions @@ -1453,8 +1351,6 @@ export class DataLakeFileClient extends DataLakePathClient { * @param offset - Optional. Offset to read file, default value is 0. * @param count - Optional. How many bytes to read, default will read from offset to the end. * @param options - Optional. Options when reading file. - * - * @memberof DataLakeFileClient */ public async read( offset: number = 0, @@ -1500,8 +1396,6 @@ export class DataLakeFileClient extends DataLakePathClient { * @param offset - Append offset in bytes. * @param length - Length of content to append in bytes. * @param options - Optional. Options when appending data. - * - * @memberof DataLakeFileClient */ public async append( body: HttpRequestBody, @@ -1545,8 +1439,6 @@ export class DataLakeFileClient extends DataLakePathClient { * equal to the length of the file after all data has been written, and there must not be a request entity body included * with the request. * @param options - Optional. Options when flushing data. - * - * @memberof DataLakeFileClient */ public async flush(position: number, options: FileFlushOptions = {}): Promise { options.conditions = options.conditions || {}; @@ -1580,8 +1472,6 @@ export class DataLakeFileClient extends DataLakePathClient { * * @param filePath - Full path of the local file * @param options - - * - * @memberof DataLakeFileClient */ public async uploadFile( filePath: string, @@ -1621,8 +1511,6 @@ export class DataLakeFileClient extends DataLakePathClient { * * @param data - Buffer(Node), Blob, ArrayBuffer or ArrayBufferView * @param options - - * - * @memberof DataLakeFileClient */ public async upload( data: Buffer | Blob | ArrayBuffer | ArrayBufferView, @@ -1813,8 +1701,6 @@ export class DataLakeFileClient extends DataLakePathClient { * * @param stream - Node.js Readable stream. * @param options - - * - * @memberof DataLakeFileClient */ public async uploadStream( stream: Readable, @@ -1910,8 +1796,6 @@ export class DataLakeFileClient extends DataLakePathClient { * @param offset - From which position of the Data Lake file to read * @param count - How much data to be read. Will read to the end when passing undefined * @param options - - * - * @memberof DataLakeFileClient */ public async readToBuffer( buffer: Buffer, @@ -1933,8 +1817,6 @@ export class DataLakeFileClient extends DataLakePathClient { * @param offset - From which position of the Data Lake file to read(in bytes) * @param count - How much data(in bytes) to be read. Will read to the end when passing undefined * @param options - - * - * @memberof DataLakeFileClient */ public async readToBuffer( offset?: number, @@ -2007,7 +1889,6 @@ export class DataLakeFileClient extends DataLakePathClient { * but with readableStreamBody set to undefined since its * content is already read and written into a local file * at the specified path. - * @memberof DataLakeFileClient */ public async readToFile( filePath: string, @@ -2062,8 +1943,6 @@ export class DataLakeFileClient extends DataLakePathClient { * * @param query - * @param options - - * - * @memberof DataLakeFileClient */ public async query(query: string, options: FileQueryOptions = {}): Promise { const { span, spanOptions } = createSpan("DataLakeFileClient-query", options.tracingOptions); @@ -2099,8 +1978,6 @@ export class DataLakeFileClient extends DataLakePathClient { * * @param mode - * @param options - - * - * @memberof DataLakeFileClient */ public async setExpiry( mode: FileExpiryMode, @@ -2159,7 +2036,6 @@ export class DataLakeFileClient extends DataLakePathClient { * * @param options - Optional parameters. * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token. - * @memberof DataLakeFileClient */ public generateSasUrl(options: FileGenerateSasUrlOptions): Promise { return new Promise((resolve) => { diff --git a/sdk/storage/storage-file-datalake/src/credentials/AnonymousCredential.ts b/sdk/storage/storage-file-datalake/src/credentials/AnonymousCredential.ts index ae6ac041bb2e..c648c39b932b 100644 --- a/sdk/storage/storage-file-datalake/src/credentials/AnonymousCredential.ts +++ b/sdk/storage/storage-file-datalake/src/credentials/AnonymousCredential.ts @@ -11,10 +11,6 @@ import { Credential } from "./Credential"; * AnonymousCredentialPolicy objects. AnonymousCredentialPolicy is used with * HTTP(S) requests that read public resources or for use with Shared Access * Signatures (SAS). - * - * @export - * @class AnonymousCredential - * @extends {Credential} */ export class AnonymousCredential extends Credential { /** @@ -22,8 +18,6 @@ export class AnonymousCredential extends Credential { * * @param nextPolicy - * @param options - - * - * @memberof AnonymousCredential */ public create( nextPolicy: RequestPolicy, diff --git a/sdk/storage/storage-file-datalake/src/credentials/Credential.ts b/sdk/storage/storage-file-datalake/src/credentials/Credential.ts index 8cc556d37638..ec1bee135c2c 100644 --- a/sdk/storage/storage-file-datalake/src/credentials/Credential.ts +++ b/sdk/storage/storage-file-datalake/src/credentials/Credential.ts @@ -7,10 +7,6 @@ import { CredentialPolicy } from "../policies/CredentialPolicy"; /** * Credential is an abstract class for Azure Storage HTTP requests signing. This * class will host an credentialPolicyCreator factory which generates CredentialPolicy. - * - * @export - * @abstract - * @class Credential */ export abstract class Credential implements RequestPolicyFactory { /** @@ -18,8 +14,6 @@ export abstract class Credential implements RequestPolicyFactory { * * @param _nextPolicy - * @param _options - - * - * @memberof Credential */ public create( // tslint:disable-next-line:variable-name diff --git a/sdk/storage/storage-file-datalake/src/credentials/StorageSharedKeyCredential.ts b/sdk/storage/storage-file-datalake/src/credentials/StorageSharedKeyCredential.ts index 30c8d3bb1426..7e4ceab82cc5 100644 --- a/sdk/storage/storage-file-datalake/src/credentials/StorageSharedKeyCredential.ts +++ b/sdk/storage/storage-file-datalake/src/credentials/StorageSharedKeyCredential.ts @@ -11,25 +11,15 @@ import { Credential } from "./Credential"; * ONLY AVAILABLE IN NODE.JS RUNTIME. * * StorageSharedKeyCredential for account key authorization of Azure Storage service. - * - * @export - * @class StorageSharedKeyCredential - * @extends {Credential} */ export class StorageSharedKeyCredential extends Credential { /** * Azure Storage account name; readonly. - * - * @type {string} - * @memberof StorageSharedKeyCredential */ public readonly accountName: string; /** * Azure Storage account key; readonly. - * - * @type {Buffer} - * @memberof StorageSharedKeyCredential */ private readonly accountKey: Buffer; @@ -37,7 +27,6 @@ export class StorageSharedKeyCredential extends Credential { * Creates an instance of StorageSharedKeyCredential. * @param accountName - * @param accountKey - - * @memberof StorageSharedKeyCredential */ constructor(accountName: string, accountKey: string) { super(); @@ -50,8 +39,6 @@ export class StorageSharedKeyCredential extends Credential { * * @param nextPolicy - * @param options - - * - * @memberof StorageSharedKeyCredential */ public create( nextPolicy: RequestPolicy, @@ -64,8 +51,6 @@ export class StorageSharedKeyCredential extends Credential { * Generates a hash signature for an HTTP request or for a SAS. * * @param stringToSign - - * - * @memberof StorageSharedKeyCredential */ public computeHMACSHA256(stringToSign: string): string { return createHmac("sha256", this.accountKey) diff --git a/sdk/storage/storage-file-datalake/src/credentials/UserDelegationKeyCredential.ts b/sdk/storage/storage-file-datalake/src/credentials/UserDelegationKeyCredential.ts index 6bc781036216..ebc9914920b2 100644 --- a/sdk/storage/storage-file-datalake/src/credentials/UserDelegationKeyCredential.ts +++ b/sdk/storage/storage-file-datalake/src/credentials/UserDelegationKeyCredential.ts @@ -9,33 +9,20 @@ import { createHmac } from "crypto"; * * UserDelegationKeyCredential is only used for generation of user delegation SAS. * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-user-delegation-sas - * - * @export - * @class UserDelegationKeyCredential */ export class UserDelegationKeyCredential { /** * Azure Storage account name; readonly. - * - * @type {string} - * @memberof UserDelegationKeyCredential */ public readonly accountName: string; /** * Azure Storage user delegation key; readonly. - * - * @type {UserDelegationKey} - * @memberof UserDelegationKeyCredential */ public readonly userDelegationKey: UserDelegationKey; /** * Key value in Buffer type. - * - * @private - * @type {Buffer} - * @memberof UserDelegationKeyCredential */ private readonly key: Buffer; @@ -43,7 +30,6 @@ export class UserDelegationKeyCredential { * Creates an instance of UserDelegationKeyCredential. * @param accountName - * @param userDelegationKey - - * @memberof UserDelegationKeyCredential */ constructor(accountName: string, userDelegationKey: UserDelegationKey) { this.accountName = accountName; @@ -55,8 +41,6 @@ export class UserDelegationKeyCredential { * Generates a hash signature for an HTTP request or for a SAS. * * @param stringToSign - - * - * @memberof UserDelegationKeyCredential */ public computeHMACSHA256(stringToSign: string): string { // console.log(`stringToSign: ${JSON.stringify(stringToSign)}`); diff --git a/sdk/storage/storage-file-datalake/src/log.ts b/sdk/storage/storage-file-datalake/src/log.ts index 4cbf5697a1e1..a90d33d9f83c 100644 --- a/sdk/storage/storage-file-datalake/src/log.ts +++ b/sdk/storage/storage-file-datalake/src/log.ts @@ -4,6 +4,6 @@ import { createClientLogger } from "@azure/logger"; /** - * The @azure/logger configuration for this package. + * The `@azure/logger` configuration for this package. */ export const logger = createClientLogger("storage-file-datalake"); diff --git a/sdk/storage/storage-file-datalake/src/models.ts b/sdk/storage/storage-file-datalake/src/models.ts index 0c129a7e438c..cbc51ba4d41f 100644 --- a/sdk/storage/storage-file-datalake/src/models.ts +++ b/sdk/storage/storage-file-datalake/src/models.ts @@ -16,31 +16,21 @@ export type ModifiedAccessConditions = Omit void; } /** * Represents an entry that failed to update Access Control List during `setAccessControlRecursive`, `updateAccessControlRecursive` and `removeAccessControlRecursive`. - * - * @export - * @interface AccessControlChangeFailure */ export interface AccessControlChangeError { /** * Returns name of an entry. - * - * @type {string} - * @memberof AccessControlChangeFailure */ name: string; /** * Returns whether entry is a directory. - * - * @type {boolean} - * @memberof AccessControlChangeFailure */ isDirectory: boolean; /** * Returns error message that is the reason why entry failed to update. - * - * @type {string} - * @memberof AccessControlChangeFailure */ message: string; } @@ -856,76 +705,46 @@ export interface AccessControlChangeError { /** * AccessControlChanges contains batch and cumulative counts of operations that change Access Control Lists recursively. * Additionally it exposes path entries that failed to update while these operations progress. - * - * @export - * @interface AccessControlChanges */ export interface AccessControlChanges { /** * Path entries that failed to update Access Control List within single batch. - * - * @type {AccessControlChangeError[]} - * @memberof AccessControlChanges */ batchFailures: AccessControlChangeError[]; /** * Counts of paths changed within single batch. - * - * @type {AccessControlChangeCounters} - * @memberof AccessControlChanges */ batchCounters: AccessControlChangeCounters; /** * Counts of paths changed from start of the operation. - * - * @type {AccessControlChangeCounters} - * @memberof AccessControlChanges */ aggregateCounters: AccessControlChangeCounters; /** * Optional. Value is present when operation is split into multiple batches and can be used to resume progress. - * - * @type {string} - * @memberof AccessControlChanges */ continuationToken?: string; } /** * AccessControlChangeCounters contains counts of operations that change Access Control Lists recursively. - * - * @export - * @interface AccessControlChangeCounters */ export interface AccessControlChangeCounters { /** * Returns number of directories where Access Control List has been updated successfully. - * - * @type {number} - * @memberof AccessControlChangeCounters */ changedDirectoriesCount: number; /** * Returns number of files where Access Control List has been updated successfully. - * - * @type {number} - * @memberof AccessControlChangeCounters */ changedFilesCount: number; /** * Returns number of paths where Access Control List update has failed. - * - * @type {number} - * @memberof AccessControlChangeCounters */ failedChangesCount: number; } /** * Response type for `setAccessControlRecursive`, `updateAccessControlRecursive` and `removeAccessControlRecursive`. - * - * @export - * @interface PathChangeAccessControlRecursiveResponse */ export interface PathChangeAccessControlRecursiveResponse { /** @@ -934,9 +753,6 @@ export interface PathChangeAccessControlRecursiveResponse { counters: AccessControlChangeCounters; /** * Optional. Value is present when operation is split into multiple batches and can be used to resume progress. - * - * @type {string} - * @memberof PathChangeAccessControlRecursiveResponse */ continuationToken?: string; } @@ -1081,17 +897,11 @@ export type PathMoveResponse = PathRemoveHeaders & { * * See: * - {@link DataLakePathClient.exists} - * - * @export - * @interface PathExistsOptions */ export interface PathExistsOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof PathExistsOptions */ abortSignal?: AbortSignalLike; // customerProvidedKey?: CpkInfo; not supported yet @@ -1099,32 +909,20 @@ export interface PathExistsOptions extends CommonOptions { /** * Contains response data for the {@link DataLakePathClient.createIfNotExists} operation. - * - * @export - * @interface PathCreateIfNotExistsResponse */ export interface PathCreateIfNotExistsResponse extends PathCreateResponse { /** * Indicate whether the directory/file is successfully created. Is false when the directory/file is not changed as it already exists. - * - * @type {boolean} - * @memberof PathCreateIfNotExistsResponse */ succeeded: boolean; } /** * Contains response data for the {@link DataLakePathClient.deleteIfExists} operation. - * - * @export - * @interface PathDeleteIfExistsResponse */ export interface PathDeleteIfExistsResponse extends PathDeleteResponse { /** * Indicate whether the directory/file is successfully deleted. Is false if the directory/file doesn't exist in the first place. - * - * @type {boolean} - * @memberof PathDeleteIfExistsResponse */ succeeded: boolean; } @@ -1134,7 +932,6 @@ export interface PathDeleteIfExistsResponse extends PathDeleteResponse { * Defines values for PathGetPropertiesAction. * Possible values include: 'getAccessControl', 'getStatus' * @readonly - * @enum {string} */ export enum PathGetPropertiesAction { GetAccessControl = "getAccessControl", @@ -1144,7 +941,6 @@ export enum PathGetPropertiesAction { * Defines values for PathRenameMode. * Possible values include: 'legacy', 'posix' * @readonly - * @enum {string} */ export enum PathRenameMode { Legacy = "legacy", @@ -1154,7 +950,6 @@ export enum PathRenameMode { * Defines values for PathResourceType. * Possible values include: 'directory', 'file' * @readonly - * @enum {string} */ export enum PathResourceType { Directory = "directory", @@ -1175,16 +970,10 @@ export interface DirectoryCreateIfNotExistsResponse extends PathCreateIfNotExist /** * Options to configure {@link DataLakeDirectoryClient.generateSasUrl} operation. - * - * @export - * @interface DirectoryGenerateSasUrlOptions */ export interface DirectoryGenerateSasUrlOptions extends CommonGenerateSasUrlOptions { /** * Optional only when identifier is provided. Specifies the list of permissions to be associated with the SAS. - * - * @type {DirectorySASPermissions} - * @memberof DirectoryGenerateSasUrlOptions */ permissions?: DirectorySASPermissions; } @@ -1274,44 +1063,29 @@ export interface FileCreateIfNotExistsResponse extends PathCreateIfNotExistsResp * - {@link DataLakeFileClient.upload} * - {@link DataLakeFileClient.uploadFile} * - {@link DataLakeFileClient.uploadStream} - * - * @export - * @interface FileParallelUploadOptions */ export interface FileParallelUploadOptions extends CommonOptions { // For all. /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileParallelUploadOptions */ abortSignal?: AbortSignalLike; /** * Access conditions headers. - * - * @type {DataLakeRequestConditions} - * @memberof FileParallelUploadOptions */ conditions?: DataLakeRequestConditions; // For create and flush. /** * Http headers. - * - * @type {PathHttpHeaders} - * @memberof FileParallelUploadOptions */ pathHttpHeaders?: PathHttpHeaders; // For create. /** * A collection of key-value string pair to associate with the Data Lake file. - * - * @type {Metadata} - * @memberof FileParallelUploadOptions */ metadata?: Metadata; @@ -1319,9 +1093,6 @@ export interface FileParallelUploadOptions extends CommonOptions { * Sets POSIX access permissions for the file owner, the file owning group, and others. * Each class may be granted read, write, or execute permission. The sticky bit is also supported. * Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. - * - * @type {string} - * @memberof FileParallelUploadOptions */ permissions?: string; // TODO: model or string? @@ -1331,18 +1102,12 @@ export interface FileParallelUploadOptions extends CommonOptions { * For example, if p is 0777 and u is 0057, then the resulting permission is 0720. * The default permission is 0666 for a file. The default umask is 0027. * The umask must be specified in 4-digit octal notation (e.g. 0766). - * - * @type {string} - * @memberof FileParallelUploadOptions */ umask?: string; // TODO: model or string? // For append. /** * Progress updater. - * - * @type {(progress: TransferProgressEvent) => void} - * @memberof FileParallelUploadOptions */ onProgress?: (progress: TransferProgressEvent) => void; @@ -1352,9 +1117,6 @@ export interface FileParallelUploadOptions extends CommonOptions { * This event has a property indicating whether this is the final change * to distinguish the difference between an intermediate flush to a file stream (when close set to "false") * and the final close of a file stream (when close set to "true"). - * - * @type {boolean} - * @memberof FileParallelUploadOptions */ close?: boolean; @@ -1366,9 +1128,6 @@ export interface FileParallelUploadOptions extends CommonOptions { * Data larger than this limit will be transferred in chunks in parallel. * Its default and max value is FILE_MAX_SINGLE_UPLOAD_THRESHOLD. * Note: {@link DataLakeFileClient.uploadStream} do not respect this field and always do parallel uploading. - * - * @type {number} - * @memberof FileParallelUploadOptions */ singleUploadThreshold?: number; @@ -1376,16 +1135,10 @@ export interface FileParallelUploadOptions extends CommonOptions { * The size of data in bytes that will be transferred in parallel. * If set to 0 or undefined, it will be automatically calculated according * to the data size. Its max value is FILE_UPLOAD_MAX_CHUNK_SIZE. - * - * @type {number} - * @memberof FileParallelUploadOptions */ chunkSize?: number; /** - * Max concurrency of parallel uploading. Must be >= 0. Its default value is DEFAULT_HIGH_LEVEL_CONCURRENCY. - * - * @type {number} - * @memberof FileParallelUploadOptions + * Max concurrency of parallel uploading. Must be greater than or equal to 0. Its default value is DEFAULT_HIGH_LEVEL_CONCURRENCY. */ maxConcurrency?: number; } @@ -1395,33 +1148,21 @@ export interface FileParallelUploadOptions extends CommonOptions { * * See: * - {@link DataLakeFileClient.readToBuffer} - * - * @export - * @interface FileReadToBufferOptions */ export interface FileReadToBufferOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileParallelUploadOptions */ abortSignal?: AbortSignalLike; /** * Access conditions headers. - * - * @type {DataLakeRequestConditions} - * @memberof FileReadToBufferOptions */ conditions?: DataLakeRequestConditions; /** * Progress updater. - * - * @type {(progress: TransferProgressEvent) => void} - * @memberof FileReadToBufferOptions */ onProgress?: (progress: TransferProgressEvent) => void; @@ -1429,138 +1170,84 @@ export interface FileReadToBufferOptions extends CommonOptions { * How many retries will perform for each read when the original chunk read stream ends unexpectedly. * Above kind of ends will not trigger retry policy defined in a pipeline, * because they doesn't emit network errors. Default value is 5. - * - * @type {number} - * @memberof FileReadToBufferOptions */ maxRetryRequestsPerChunk?: number; /** * chunkSize is size of data every request trying to read. - * Must be >= 0, if set to 0 or undefined, it will automatically calculated according + * Must be greater than or equal to 0, if set to 0 or undefined, it will automatically calculated according * to the file size. - * - * @type {number} - * @memberof FileReadToBufferOptions */ chunkSize?: number; /** * Concurrency of parallel read. - * - * @type {number} - * @memberof FileReadToBufferOptions */ concurrency?: number; } /** * Options to query file with JSON format. - * - * @export - * @interface FileQueryJsonTextConfiguration */ export interface FileQueryJsonTextConfiguration { /** * Record separator. - * - * @type {string} - * @memberof FileQueryJsonTextConfiguration */ recordSeparator: string; /** * Query for a JSON format file. - * - * @type {"json"} - * @memberof FileQueryJsonTextConfiguration */ kind: "json"; } /** * Options to query file with CSV format. - * - * @export - * @interface FileQueryCsvTextConfiguration */ export interface FileQueryCsvTextConfiguration { /** * Record separator. - * - * @type {string} - * @memberof FileQueryCsvTextConfiguration */ recordSeparator: string; /** * Query for a CSV format file. - * - * @type {"csv"} - * @memberof FileQueryCsvTextConfiguration */ kind: "csv"; /** * Column separator. Default is ",". - * - * @type {string} - * @memberof FileQueryCsvTextConfiguration */ columnSeparator?: string; /** * Field quote. - * - * @type {string} - * @memberof FileQueryCsvTextConfiguration */ fieldQuote?: string; /** * Escape character. - * - * @type {string} - * @memberof FileQueryCsvTextConfiguration */ escapeCharacter?: string; /** * Has headers. Default is false. - * - * @type {boolean} - * @memberof FileQueryCsvTextConfiguration */ hasHeaders?: boolean; } /** * File query error type. - * - * @export - * @interface FileQueryError */ export interface FileQueryError { /** * Whether the error is fatal or not. A fatal error will stop the query. - * - * @type {boolean} - * @memberof FileQueryError */ isFatal: boolean; /** * Error name. - * - * @type {string} - * @memberof FileQueryError */ name: string; /** * Position in bytes of the query. - * - * @type {number} - * @memberof FileQueryError */ position: number; /** * Error description. - * - * @type {string} - * @memberof FileQueryError */ description: string; } @@ -1570,31 +1257,19 @@ export interface FileQueryError { * * See: * - {@link DataLakeFileClient.query} - * - * @export - * @interface FileQueryOptions */ export interface FileQueryOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileQueryOptions */ abortSignal?: AbortSignalLike; /** * Configurations for the query input. - * - * @type {FileQueryJsonTextConfiguration | FileQueryCsvTextConfiguration} - * @memberof FileQueryOptions */ inputTextConfiguration?: FileQueryJsonTextConfiguration | FileQueryCsvTextConfiguration; /** * Configurations for the query output. - * - * @type {FileQueryJsonTextConfiguration | FileQueryCsvTextConfiguration | FileQueryArrowConfiguration} - * @memberof FileQueryOptions */ outputTextConfiguration?: | FileQueryJsonTextConfiguration @@ -1602,72 +1277,46 @@ export interface FileQueryOptions extends CommonOptions { | FileQueryArrowConfiguration; /** * Callback to receive events on the progress of query operation. - * - * @type {(progress: TransferProgressEvent) => void} - * @memberof FileQueryOptions */ onProgress?: (progress: TransferProgressEvent) => void; /** * Callback to receive error events during the query operaiton. - * - * @memberof FileQueryOptions */ onError?: (error: FileQueryError) => void; /** * Conditions to meet when uploading to the block file. - * - * @type {FileRequestConditions} - * @memberof FileQueryOptions */ conditions?: DataLakeRequestConditions; } /** * Option interface for the {@link DataLakeFileClient.setExpiry} operation. - * - * @export - * @interface FileSetExpiryOptions */ export interface FileSetExpiryOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileSetExpiryOptions */ abortSignal?: AbortSignalLike; /** * The time to set the file to expire on, used in combination with the "Absolute" {@link FileExpiryMode}. * A time in the past is not allowed and milliseconds will be dropped. - * - * @type {Date} - * @memberof FileSetExpiryOptions */ expiresOn?: Date; /** * The number of milliseconds to elapse before the file expires, used in combination with the "RelativeToCreation" or "RelativeToNow" {@link FileExpiryMode}. - * - * @type {number} - * @memberof FileSetExpiryOptions */ timeToExpireInMs?: number; } /** * Options to configure {@link DataLakeFileClient.generateSasUrl} operation. - * - * @export - * @interface FileGenerateSasUrlOptions */ export interface FileGenerateSasUrlOptions extends CommonGenerateSasUrlOptions { /** * Optional only when identifier is provided. Specifies the list of permissions to be associated with the SAS. - * - * @type {DataLakeSASPermissions} - * @memberof FileGenerateSasUrlOptions */ permissions?: DataLakeSASPermissions; } diff --git a/sdk/storage/storage-file-datalake/src/policies/AnonymousCredentialPolicy.ts b/sdk/storage/storage-file-datalake/src/policies/AnonymousCredentialPolicy.ts index 743528139e91..08e4118ad4c0 100644 --- a/sdk/storage/storage-file-datalake/src/policies/AnonymousCredentialPolicy.ts +++ b/sdk/storage/storage-file-datalake/src/policies/AnonymousCredentialPolicy.ts @@ -8,17 +8,12 @@ import { CredentialPolicy } from "./CredentialPolicy"; /** * AnonymousCredentialPolicy is used with HTTP(S) requests that read public resources * or for use with Shared Access Signatures (SAS). - * - * @export - * @class AnonymousCredentialPolicy - * @extends {CredentialPolicy} */ export class AnonymousCredentialPolicy extends CredentialPolicy { /** * Creates an instance of AnonymousCredentialPolicy. * @param nextPolicy - * @param options - - * @memberof AnonymousCredentialPolicy */ constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions) { super(nextPolicy, options); diff --git a/sdk/storage/storage-file-datalake/src/policies/CredentialPolicy.ts b/sdk/storage/storage-file-datalake/src/policies/CredentialPolicy.ts index e8796c296e71..a0866f5705f3 100644 --- a/sdk/storage/storage-file-datalake/src/policies/CredentialPolicy.ts +++ b/sdk/storage/storage-file-datalake/src/policies/CredentialPolicy.ts @@ -6,19 +6,12 @@ import { BaseRequestPolicy, HttpOperationResponse, WebResource } from "@azure/co /** * Credential policy used to sign HTTP(S) requests before sending. This is an * abstract class. - * - * @export - * @abstract - * @class CredentialPolicy - * @extends {BaseRequestPolicy} */ export abstract class CredentialPolicy extends BaseRequestPolicy { /** * Sends out request. * * @param request - - * - * @memberof CredentialPolicy */ public sendRequest(request: WebResource): Promise { return this._nextPolicy.sendRequest(this.signRequest(request)); @@ -28,11 +21,7 @@ export abstract class CredentialPolicy extends BaseRequestPolicy { * Child classes must implement this method with request signing. This method * will be executed in {@link sendRequest}. * - * @protected - * @abstract * @param request - - * - * @memberof CredentialPolicy */ protected signRequest(request: WebResource): WebResource { // Child classes must override this method with request signing. This method diff --git a/sdk/storage/storage-file-datalake/src/policies/StorageBrowserPolicy.ts b/sdk/storage/storage-file-datalake/src/policies/StorageBrowserPolicy.ts index c5170fbd70ac..6381a2e16927 100644 --- a/sdk/storage/storage-file-datalake/src/policies/StorageBrowserPolicy.ts +++ b/sdk/storage/storage-file-datalake/src/policies/StorageBrowserPolicy.ts @@ -22,16 +22,12 @@ import { setURLParameter } from "../utils/utils.common"; * 2. Remove cookie header for security * * 3. Remove content-length header to avoid browsers warning - * - * @class StorageBrowserPolicy - * @extends {BaseRequestPolicy} */ export class StorageBrowserPolicy extends BaseRequestPolicy { /** * Creates an instance of StorageBrowserPolicy. * @param nextPolicy - * @param options - - * @memberof StorageBrowserPolicy */ constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions) { super(nextPolicy, options); @@ -41,8 +37,6 @@ export class StorageBrowserPolicy extends BaseRequestPolicy { * Sends out request. * * @param request - - * - * @memberof StorageBrowserPolicy */ public async sendRequest(request: WebResource): Promise { if (isNode) { diff --git a/sdk/storage/storage-file-datalake/src/policies/StorageRetryPolicy.ts b/sdk/storage/storage-file-datalake/src/policies/StorageRetryPolicy.ts index 9f4541e69189..f6a0cb8a38f3 100644 --- a/sdk/storage/storage-file-datalake/src/policies/StorageRetryPolicy.ts +++ b/sdk/storage/storage-file-datalake/src/policies/StorageRetryPolicy.ts @@ -20,7 +20,6 @@ import { logger } from "../log"; /** * A factory method used to generated a RetryPolicy factory. * - * @export * @param retryOptions - */ export function NewRetryPolicyFactory(retryOptions?: StorageRetryOptions): RequestPolicyFactory { @@ -33,9 +32,6 @@ export function NewRetryPolicyFactory(retryOptions?: StorageRetryOptions): Reque /** * RetryPolicy types. - * - * @export - * @enum {number} */ export enum StorageRetryPolicyType { /** @@ -62,17 +58,10 @@ const RETRY_ABORT_ERROR = new AbortError("The operation was aborted."); /** * Retry policy with exponential retry and linear retry implemented. - * - * @class RetryPolicy - * @extends {BaseRequestPolicy} */ export class StorageRetryPolicy extends BaseRequestPolicy { /** * RetryOptions. - * - * @private - * @type {StorageRetryOptions} - * @memberof StorageRetryPolicy */ private readonly retryOptions: StorageRetryOptions; @@ -82,7 +71,6 @@ export class StorageRetryPolicy extends BaseRequestPolicy { * @param nextPolicy - * @param options - * @param retryOptions - - * @memberof StorageRetryPolicy */ constructor( nextPolicy: RequestPolicy, @@ -132,8 +120,6 @@ export class StorageRetryPolicy extends BaseRequestPolicy { * Sends request. * * @param request - - * - * @memberof StorageRetryPolicy */ public async sendRequest(request: WebResource): Promise { return this.attemptSendRequest(request, false, 1); @@ -142,15 +128,12 @@ export class StorageRetryPolicy extends BaseRequestPolicy { /** * Decide and perform next retry. Won't mutate request parameter. * - * @protected * @param request - * @param secondaryHas404 - If attempt was against the secondary & it returned a StatusNotFound (404), then * the resource was not found. This may be due to replication delay. So, in this * case, we'll never try the secondary again for this operation. * @param attempt - How many retries has been attempted to performed, starting from 1, which includes * the attempt will be performed by this method call. - * - * @memberof StorageRetryPolicy */ protected async attemptSendRequest( request: WebResource, @@ -201,13 +184,10 @@ export class StorageRetryPolicy extends BaseRequestPolicy { /** * Decide whether to retry according to last HTTP response and retry counters. * - * @protected * @param isPrimaryRetry - * @param attempt - * @param response - * @param err - - * - * @memberof StorageRetryPolicy */ protected shouldRetry( isPrimaryRetry: boolean, @@ -279,11 +259,9 @@ export class StorageRetryPolicy extends BaseRequestPolicy { /** * Delay a calculated time between retries. * - * @private * @param isPrimaryRetry - * @param attempt - * @param abortSignal - - * @memberof StorageRetryPolicy */ private async delay(isPrimaryRetry: boolean, attempt: number, abortSignal?: AbortSignalLike) { let delayTimeInMs: number = 0; diff --git a/sdk/storage/storage-file-datalake/src/policies/StorageSharedKeyCredentialPolicy.ts b/sdk/storage/storage-file-datalake/src/policies/StorageSharedKeyCredentialPolicy.ts index f14f541447f1..2e964954fc3e 100644 --- a/sdk/storage/storage-file-datalake/src/policies/StorageSharedKeyCredentialPolicy.ts +++ b/sdk/storage/storage-file-datalake/src/policies/StorageSharedKeyCredentialPolicy.ts @@ -9,17 +9,10 @@ import { CredentialPolicy } from "./CredentialPolicy"; /** * StorageSharedKeyCredentialPolicy is a policy used to sign HTTP request with a shared key. - * - * @export - * @class StorageSharedKeyCredentialPolicy - * @extends {CredentialPolicy} */ export class StorageSharedKeyCredentialPolicy extends CredentialPolicy { /** * Reference to StorageSharedKeyCredential which generates StorageSharedKeyCredentialPolicy - * - * @type {StorageSharedKeyCredential} - * @memberof StorageSharedKeyCredentialPolicy */ private readonly factory: StorageSharedKeyCredential; @@ -28,7 +21,6 @@ export class StorageSharedKeyCredentialPolicy extends CredentialPolicy { * @param nextPolicy - * @param options - * @param factory - - * @memberof StorageSharedKeyCredentialPolicy */ constructor( nextPolicy: RequestPolicy, @@ -42,10 +34,7 @@ export class StorageSharedKeyCredentialPolicy extends CredentialPolicy { /** * Signs request. * - * @protected * @param request - - * - * @memberof StorageSharedKeyCredentialPolicy */ protected signRequest(request: WebResource): WebResource { request.headers.set(HeaderConstants.X_MS_DATE, new Date().toUTCString()); @@ -95,11 +84,8 @@ export class StorageSharedKeyCredentialPolicy extends CredentialPolicy { * Retrieve header value according to shared key sign rules. * @see https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key * - * @private * @param request - * @param headerName - - * - * @memberof StorageSharedKeyCredentialPolicy */ private getHeaderValueToSign(request: WebResource, headerName: string): string { const value = request.headers.get(headerName); @@ -129,10 +115,7 @@ export class StorageSharedKeyCredentialPolicy extends CredentialPolicy { * 6. Finally, append a new-line character to each canonicalized header in the resulting list. * Construct the CanonicalizedHeaders string by concatenating all headers in this list into a single string. * - * @private * @param request - - * - * @memberof StorageSharedKeyCredentialPolicy */ private getCanonicalizedHeadersString(request: WebResource): string { let headersArray = request.headers.headersArray().filter((value) => { @@ -164,10 +147,7 @@ export class StorageSharedKeyCredentialPolicy extends CredentialPolicy { /** * Retrieves the webResource canonicalized resource string. * - * @private * @param request - - * - * @memberof StorageSharedKeyCredentialPolicy */ private getCanonicalizedResourceString(request: WebResource): string { const path = getURLPath(request.url) || "/"; diff --git a/sdk/storage/storage-file-datalake/src/policies/TelemetryPolicy.ts b/sdk/storage/storage-file-datalake/src/policies/TelemetryPolicy.ts index 519397076b4e..8ec37fecc2c7 100644 --- a/sdk/storage/storage-file-datalake/src/policies/TelemetryPolicy.ts +++ b/sdk/storage/storage-file-datalake/src/policies/TelemetryPolicy.ts @@ -15,16 +15,10 @@ import { HeaderConstants } from "../utils/constants"; /** * TelemetryPolicy is a policy used to tag user-agent header for every requests. - * - * @class TelemetryPolicy - * @extends {BaseRequestPolicy} */ export class TelemetryPolicy extends BaseRequestPolicy { /** * Telemetry string. - * - * @type {string} - * @memberof TelemetryPolicy */ public readonly telemetry: string; @@ -33,7 +27,6 @@ export class TelemetryPolicy extends BaseRequestPolicy { * @param nextPolicy - * @param options - * @param telemetry - - * @memberof TelemetryPolicy */ constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, telemetry: string) { super(nextPolicy, options); @@ -44,8 +37,6 @@ export class TelemetryPolicy extends BaseRequestPolicy { * Sends out request. * * @param request - - * - * @memberof TelemetryPolicy */ public async sendRequest(request: WebResource): Promise { if (isNode) { diff --git a/sdk/storage/storage-file-datalake/src/sas/AccountSASPermissions.ts b/sdk/storage/storage-file-datalake/src/sas/AccountSASPermissions.ts index b78d4366de64..018408a6964f 100644 --- a/sdk/storage/storage-file-datalake/src/sas/AccountSASPermissions.ts +++ b/sdk/storage/storage-file-datalake/src/sas/AccountSASPermissions.ts @@ -9,18 +9,12 @@ * values are set, this should be serialized with toString and set as the permissions field on an * {@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 - * @class AccountSASPermissions */ export class AccountSASPermissions { /** * Parse initializes the AccountSASPermissions fields from a string. * - * @static * @param permissions - - * - * @memberof AccountSASPermissions */ public static parse(permissions: string): AccountSASPermissions { const accountSASPermissions = new AccountSASPermissions(); @@ -61,65 +55,41 @@ export class AccountSASPermissions { /** * Permission to read resources and list queues and tables granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public read: boolean = false; /** * Permission to write resources granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public write: boolean = false; /** * Permission to delete blobs and files granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public delete: boolean = false; /** * Permission to list blob containers, blobs, shares, directories, and files granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public list: boolean = false; /** * Permission to add messages, table entities, and append to blobs granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public add: boolean = false; /** * Permission to create blobs and files granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public create: boolean = false; /** * Permissions to update messages and table entities granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public update: boolean = false; /** * Permission to get and delete messages granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public process: boolean = false; @@ -132,8 +102,6 @@ export class AccountSASPermissions { * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas * - * - * @memberof AccountSASPermissions */ public toString(): string { // The order of the characters should be as specified here to ensure correctness: diff --git a/sdk/storage/storage-file-datalake/src/sas/AccountSASResourceTypes.ts b/sdk/storage/storage-file-datalake/src/sas/AccountSASResourceTypes.ts index 9ea91080641a..7596c6ff5ed1 100644 --- a/sdk/storage/storage-file-datalake/src/sas/AccountSASResourceTypes.ts +++ b/sdk/storage/storage-file-datalake/src/sas/AccountSASResourceTypes.ts @@ -9,19 +9,13 @@ * values are set, this should be serialized with toString and set as the resources field on an * {@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 - * @class AccountSASResourceTypes */ export class AccountSASResourceTypes { /** * Creates an {@link AccountSASResourceTypes} from the specified resource types string. This method will throw an * Error if it encounters a character that does not correspond to a valid resource type. * - * @static * @param resourceTypes - - * - * @memberof AccountSASResourceTypes */ public static parse(resourceTypes: string): AccountSASResourceTypes { const accountSASResourceTypes = new AccountSASResourceTypes(); @@ -47,25 +41,16 @@ export class AccountSASResourceTypes { /** * Permission to access service level APIs granted. - * - * @type {boolean} - * @memberof AccountSASResourceTypes */ public service: boolean = false; /** * Permission to access container level APIs (Blob Containers, Tables, Queues, File Shares, File Systems) granted. - * - * @type {boolean} - * @memberof AccountSASResourceTypes */ public container: boolean = false; /** * Permission to access object level APIs (Blobs, Table Entities, Queue Messages, Files, Directories) granted. - * - * @type {boolean} - * @memberof AccountSASResourceTypes */ public object: boolean = false; @@ -74,8 +59,6 @@ export class AccountSASResourceTypes { * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas * - * - * @memberof AccountSASResourceTypes */ public toString(): string { const resourceTypes: string[] = []; diff --git a/sdk/storage/storage-file-datalake/src/sas/AccountSASServices.ts b/sdk/storage/storage-file-datalake/src/sas/AccountSASServices.ts index ec20a4f02660..3ef2a0cd8e45 100644 --- a/sdk/storage/storage-file-datalake/src/sas/AccountSASServices.ts +++ b/sdk/storage/storage-file-datalake/src/sas/AccountSASServices.ts @@ -9,19 +9,13 @@ * values are set, this should be serialized with toString and set as the services field on an * {@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 - * @class AccountSASServices */ export class AccountSASServices { /** * Creates an {@link AccountSASServices} from the specified services string. This method will throw an * Error if it encounters a character that does not correspond to a valid service. * - * @static * @param services - - * - * @memberof AccountSASServices */ public static parse(services: string): AccountSASServices { const accountSASServices = new AccountSASServices(); @@ -50,41 +44,27 @@ export class AccountSASServices { /** * Permission to access blob and data lake resources granted. - * - * @type {boolean} - * @memberof AccountSASServices */ public blob: boolean = false; /** * Permission to access file resources granted. - * - * @type {boolean} - * @memberof AccountSASServices */ public file: boolean = false; /** * Permission to access queue resources granted. - * - * @type {boolean} - * @memberof AccountSASServices */ public queue: boolean = false; /** * Permission to access table resources granted. - * - * @type {boolean} - * @memberof AccountSASServices */ public table: boolean = false; /** * Converts the given services to a string. * - * - * @memberof AccountSASServices */ public toString(): string { const services: string[] = []; diff --git a/sdk/storage/storage-file-datalake/src/sas/AccountSASSignatureValues.ts b/sdk/storage/storage-file-datalake/src/sas/AccountSASSignatureValues.ts index 5e4a83204963..c6d3e6f3402e 100644 --- a/sdk/storage/storage-file-datalake/src/sas/AccountSASSignatureValues.ts +++ b/sdk/storage/storage-file-datalake/src/sas/AccountSASSignatureValues.ts @@ -24,75 +24,48 @@ import { truncatedISO8061Date } from "../utils/utils.common"; * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas * for descriptions of the parameters, including which are required - * - * @export - * @class AccountSASSignatureValues */ export interface AccountSASSignatureValues { /** * If not provided, this defaults to the service version targeted by this version of the library. - * - * @type {string} - * @memberof AccountSASSignatureValues */ version?: string; /** * Optional. SAS protocols allowed. - * - * @type {SASProtocol} - * @memberof AccountSASSignatureValues */ protocol?: SASProtocol; /** * Optional. When the SAS will take effect. - * - * @type {Date} - * @memberof AccountSASSignatureValues */ startsOn?: Date; /** * The time after which the SAS will no longer work. - * - * @type {Date} - * @memberof AccountSASSignatureValues */ expiresOn: Date; /** * Specifies which operations the SAS user may perform. Please refer to {@link AccountSASPermissions} for help * constructing the permissions string. - * - * @type {AccountSASPermissions} - * @memberof AccountSASSignatureValues */ permissions: AccountSASPermissions; /** * Optional. IP range allowed. - * - * @type {SasIPRange} - * @memberof AccountSASSignatureValues */ ipRange?: SasIPRange; /** * The values that indicate the services accessible with this SAS. Please refer to {@link AccountSASServices} to * construct this value. - * - * @type {string} - * @memberof AccountSASSignatureValues */ services: string; /** * The values that indicate the resource types accessible with this SAS. Please refer * to {@link AccountSASResourceTypes} to construct this value. - * - * @type {string} - * @memberof AccountSASSignatureValues */ resourceTypes: string; } @@ -107,8 +80,6 @@ export interface AccountSASSignatureValues { * * @param accountSASSignatureValues - * @param sharedKeyCredential - - * - * @memberof AccountSASSignatureValues */ export function generateAccountSASQueryParameters( accountSASSignatureValues: AccountSASSignatureValues, diff --git a/sdk/storage/storage-file-datalake/src/sas/DataLakeSASPermissions.ts b/sdk/storage/storage-file-datalake/src/sas/DataLakeSASPermissions.ts index 0b25727fbf08..76b1073bcc17 100644 --- a/sdk/storage/storage-file-datalake/src/sas/DataLakeSASPermissions.ts +++ b/sdk/storage/storage-file-datalake/src/sas/DataLakeSASPermissions.ts @@ -9,19 +9,13 @@ * the values are set, this should be serialized with toString and set as the permissions field on a * {@link DataLakeSASSignatureValues} 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 - * @class DataLakeSASPermissions */ export class DataLakeSASPermissions { /** * Creates a {@link DataLakeSASPermissions} from the specified permissions string. This method will throw an * Error if it encounters a character that does not correspond to a valid permission. * - * @static * @param permissions - - * - * @memberof DataLakeSASPermissions */ public static parse(permissions: string): DataLakeSASPermissions { const blobSASPermissions = new DataLakeSASPermissions(); @@ -65,57 +59,36 @@ export class DataLakeSASPermissions { /** * Specifies Read access granted. - * - * @type {boolean} - * @memberof DataLakeSASPermissions */ public read: boolean = false; /** * Specifies Add access granted. - * - * @type {boolean} - * @memberof DataLakeSASPermissions */ public add: boolean = false; /** * Specifies Create access granted. - * - * @type {boolean} - * @memberof DataLakeSASPermissions */ public create: boolean = false; /** * Specifies Write access granted. - * - * @type {boolean} - * @memberof DataLakeSASPermissions */ public write: boolean = false; /** * Specifies Delete access granted. - * - * @type {boolean} - * @memberof DataLakeSASPermissions */ public delete: boolean = false; /** * Specifies Move access granted. - * - * @type {boolean} - * @memberof DirectorySASPermissions */ public move: boolean = false; /** * Specifies Execute access granted. - * - * @type {boolean} - * @memberof DirectorySASPermissions */ public execute: boolean = false; @@ -123,18 +96,12 @@ export class DataLakeSASPermissions { * Specifies Ownership access granted, which allows the caller to set owner, owning group, * or act as the owner when renaming or deleting a blob (file or directory) within a folder * that has the sticky bit set. - * - * @type {boolean} - * @memberof DirectorySASPermissions */ public manageOwnership: boolean = false; /** * Specifies Permission access granted, which allows the caller to set permissions and * POSIX ACLs on blobs (files and directories). - * - * @type {boolean} - * @memberof DirectorySASPermissions */ public manageAccessControl: boolean = false; @@ -143,7 +110,6 @@ export class DataLakeSASPermissions { * order accepted by the service. * * @returns A string which represents the DataLakeSASPermissions - * @memberof DataLakeSASPermissions */ public toString(): string { const permissions: string[] = []; diff --git a/sdk/storage/storage-file-datalake/src/sas/DataLakeSASSignatureValues.ts b/sdk/storage/storage-file-datalake/src/sas/DataLakeSASSignatureValues.ts index daf1a67d441f..a5c2b5bc25e4 100644 --- a/sdk/storage/storage-file-datalake/src/sas/DataLakeSASSignatureValues.ts +++ b/sdk/storage/storage-file-datalake/src/sas/DataLakeSASSignatureValues.ts @@ -15,41 +15,26 @@ import { DirectorySASPermissions } from "./DirectorySASPermissions"; * ONLY AVAILABLE IN NODE.JS RUNTIME. * * DataLakeSASSignatureValues is used to help generating Blob and DataLake service SAS tokens for containers, blobs, filesystem, directories and files. - * - * @export - * @class DataLakeSASSignatureValues */ export interface DataLakeSASSignatureValues { /** * 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 DataLakeSASSignatureValues */ version?: string; /** * Optional. SAS protocols, HTTPS only or HTTPSandHTTP - * - * @type {SASProtocol} - * @memberof DataLakeSASSignatureValues */ protocol?: SASProtocol; /** * Optional. When the SAS will take effect. - * - * @type {Date} - * @memberof DataLakeSASSignatureValues */ startsOn?: Date; /** * Optional only when identifier is provided. The time after which the SAS will no longer work. - * - * @type {Date} - * @memberof DataLakeSASSignatureValues */ expiresOn?: Date; @@ -57,33 +42,21 @@ export interface DataLakeSASSignatureValues { * Optional only when identifier is provided. * Please refer to {@link FileSystemSASPermissions}, {@link DirectorySASPermissions} or {@link DataLakeSASPermissions} depending on the resource * being accessed for help constructing the permissions string. - * - * @type {DataLakeSASPermissions | DirectorySASPermissions | FileSystemSASPermissions} - * @memberof DataLakeSASSignatureValues */ permissions?: DataLakeSASPermissions | DirectorySASPermissions | FileSystemSASPermissions; /** * Optional. IP ranges allowed in this SAS. - * - * @type {SasIPRange} - * @memberof DataLakeSASSignatureValues */ ipRange?: SasIPRange; /** * The name of the file system the SAS user may access. - * - * @type {string} - * @memberof DataLakeSASSignatureValues */ fileSystemName: string; /** * Optional. The path name of the directory or file SAS user may access. Required if snapshotTime is provided. - * - * @type {string} - * @memberof DataLakeSASSignatureValues */ pathName?: string; @@ -91,18 +64,12 @@ export interface DataLakeSASSignatureValues { * Optional. Beginning in version 2020-02-10, this value defines whether or not the {@link pathName} is a directory. * If this value is set to true, the Path is a Directory for a Directory SAS. If set to false or default, the Path * is a File Path for a File Path SAS. - * - * @type {boolean} - * @memberof DataLakeSASSignatureValues */ isDirectory?: boolean; /** * Optional. Beginning in version 2020-02-10, indicate the depth of the directory specified in the canonicalizedresource field of the string-to-sign. * The depth of the directory is the number of directories beneath the root folder. - * - * @type {number} - * @memberof DataLakeSASSignatureValues */ directoryDepth?: number; @@ -112,9 +79,6 @@ export interface DataLakeSASSignatureValues { * ensure that the owner of the user delegation key has the required permissions before granting access but no additional permission * check for the user specified in this value will be performed. This cannot be used in conjuction with {@link agentObjectId}. * This is only used for User Delegation SAS. - * - * @type {string} - * @memberof DataLakeSASSignatureValues */ preauthorizedAgentObjectId?: string; @@ -123,26 +87,17 @@ export interface DataLakeSASSignatureValues { * to be unauthorized by the owner of the user delegation key. The Azure Storage Service will perform an additional POSIX ACL check to determine * if the user is authorized to perform the requested operation. This cannot be used in conjuction with {@link preauthorizedAgentObjectId}. * This is only used for User Delegation SAS. - * - * @type {string} - * @memberof DataLakeSASSignatureValues */ agentObjectId?: string; /** * Optional. Beginning in version 2020-02-10, this is a GUID value that will be logged in the storage diagnostic logs and can be used to * correlate SAS generation with storage resource access. This is only used for User Delegation SAS. - * - * @type {string} - * @memberof DataLakeSASSignatureValues */ correlationId?: string; /** * Optional. Snapshot timestamp string the SAS user may access. Only supported from API version 2018-11-09. - * - * @type {string} - * @memberof DataLakeSASSignatureValues */ snapshotTime?: string; @@ -150,49 +105,31 @@ export interface DataLakeSASSignatureValues { * Optional. The name of the access policy on the file system this SAS references if any. * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy - * - * @type {string} - * @memberof DataLakeSASSignatureValues */ identifier?: string; /** * Optional. The cache-control header for the SAS. - * - * @type {string} - * @memberof DataLakeSASSignatureValues */ cacheControl?: string; /** * Optional. The content-disposition header for the SAS. - * - * @type {string} - * @memberof DataLakeSASSignatureValues */ contentDisposition?: string; /** * Optional. The content-encoding header for the SAS. - * - * @type {string} - * @memberof DataLakeSASSignatureValues */ contentEncoding?: string; /** * Optional. The content-language header for the SAS. - * - * @type {string} - * @memberof DataLakeSASSignatureValues */ contentLanguage?: string; /** * Optional. The content-type header for the SAS. - * - * @type {string} - * @memberof DataLakeSASSignatureValues */ contentType?: string; } @@ -249,10 +186,8 @@ export interface DataLakeSASSignatureValues { * ).toString(); * ``` * - * @export * @param dataLakeSASSignatureValues - * @param sharedKeyCredential - - * */ export function generateDataLakeSASQueryParameters( dataLakeSASSignatureValues: DataLakeSASSignatureValues, @@ -276,18 +211,16 @@ export function generateDataLakeSASQueryParameters( * expiresOn, // Required. Date type * ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional * protocol: SASProtocol.HttpsAndHttp, // Optional - * version: "2018-11-09" // Must >= 2018-11-09 to generate user delegation SAS + * version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS * }, * userDelegationKey, // UserDelegationKey * accountName * ).toString(); * ``` * - * @export * @param dataLakeSASSignatureValues - * @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()` * @param accountName - - * */ export function generateDataLakeSASQueryParameters( dataLakeSASSignatureValues: DataLakeSASSignatureValues, @@ -376,7 +309,6 @@ export function generateDataLakeSASQueryParameters( * * @param dataLakeSASSignatureValues - * @param sharedKeyCredential - - * */ function generateBlobSASQueryParameters20150405( dataLakeSASSignatureValues: DataLakeSASSignatureValues, @@ -483,7 +415,6 @@ function generateBlobSASQueryParameters20150405( * * @param dataLakeSASSignatureValues - * @param sharedKeyCredential - - * */ function generateBlobSASQueryParameters20181109( dataLakeSASSignatureValues: DataLakeSASSignatureValues, @@ -605,7 +536,6 @@ function generateBlobSASQueryParameters20181109( * * @param dataLakeSASSignatureValues - * @param userDelegationKeyCredential - - * */ function generateBlobSASQueryParametersUDK20181109( dataLakeSASSignatureValues: DataLakeSASSignatureValues, @@ -733,7 +663,6 @@ function generateBlobSASQueryParametersUDK20181109( * * @param dataLakeSASSignatureValues - * @param userDelegationKeyCredential - - * */ function generateBlobSASQueryParametersUDK20200210( dataLakeSASSignatureValues: DataLakeSASSignatureValues, diff --git a/sdk/storage/storage-file-datalake/src/sas/DirectorySASPermissions.ts b/sdk/storage/storage-file-datalake/src/sas/DirectorySASPermissions.ts index 63a8dff0c398..910049076bd7 100644 --- a/sdk/storage/storage-file-datalake/src/sas/DirectorySASPermissions.ts +++ b/sdk/storage/storage-file-datalake/src/sas/DirectorySASPermissions.ts @@ -7,19 +7,13 @@ * Once all the values are set, this should be serialized with toString and set as the permissions field on a * {@link DataLakeSASSignatureValues} 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 - * @class DirectorySASPermissions */ export class DirectorySASPermissions { /** * Creates an {@link DirectorySASPermissions} from the specified permissions string. This method will throw an * Error if it encounters a character that does not correspond to a valid permission. * - * @static * @param permissions - - * - * @memberof DirectorySASPermissions */ public static parse(permissions: string) { const directorySASPermissions = new DirectorySASPermissions(); @@ -66,65 +60,41 @@ export class DirectorySASPermissions { /** * Specifies Read access granted. - * - * @type {boolean} - * @memberof DirectorySASPermissions */ public read: boolean = false; /** * Specifies Add access granted. - * - * @type {boolean} - * @memberof DirectorySASPermissions */ public add: boolean = false; /** * Specifies Create access granted. - * - * @type {boolean} - * @memberof DirectorySASPermissions */ public create: boolean = false; /** * Specifies Write access granted. - * - * @type {boolean} - * @memberof DirectorySASPermissions */ public write: boolean = false; /** * Specifies Delete access granted. - * - * @type {boolean} - * @memberof DirectorySASPermissions */ public delete: boolean = false; /** * Specifies List access granted. - * - * @type {boolean} - * @memberof DirectorySASPermissions */ public list: boolean = false; /** * Specifies Move access granted. - * - * @type {boolean} - * @memberof DirectorySASPermissions */ public move: boolean = false; /** * Specifies Execute access granted. - * - * @type {boolean} - * @memberof DirectorySASPermissions */ public execute: boolean = false; @@ -132,18 +102,12 @@ export class DirectorySASPermissions { * Specifies Ownership access granted, which allows the caller to set owner, owning group, * or act as the owner when renaming or deleting a blob (file or directory) within a folder * that has the sticky bit set. - * - * @type {boolean} - * @memberof DirectorySASPermissions */ public manageOwnership: boolean = false; /** * Specifies Permission access granted, which allows the caller to set permissions and * POSIX ACLs on blobs (files and directories). - * - * @type {boolean} - * @memberof DirectorySASPermissions */ public manageAccessControl: boolean = false; @@ -154,8 +118,6 @@ export class DirectorySASPermissions { * The order of the characters should be as specified here to ensure correctness. * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas * - * - * @memberof DirectorySASPermissions */ public toString(): string { const permissions: string[] = []; diff --git a/sdk/storage/storage-file-datalake/src/sas/FileSystemSASPermissions.ts b/sdk/storage/storage-file-datalake/src/sas/FileSystemSASPermissions.ts index 43c9d52c15e0..4b7f4534fd05 100644 --- a/sdk/storage/storage-file-datalake/src/sas/FileSystemSASPermissions.ts +++ b/sdk/storage/storage-file-datalake/src/sas/FileSystemSASPermissions.ts @@ -7,19 +7,13 @@ * Once all the values are set, this should be serialized with toString and set as the permissions field on a * {@link DataLakeSASSignatureValues} 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 - * @class FileSystemSASPermissions */ export class FileSystemSASPermissions { /** * Creates an {@link FileSystemSASPermissions} from the specified permissions string. This method will throw an * Error if it encounters a character that does not correspond to a valid permission. * - * @static * @param permissions - - * - * @memberof FileSystemSASPermissions */ public static parse(permissions: string) { const containerSASPermissions = new FileSystemSASPermissions(); @@ -66,65 +60,41 @@ export class FileSystemSASPermissions { /** * Specifies Read access granted. - * - * @type {boolean} - * @memberof FileSystemSASPermissions */ public read: boolean = false; /** * Specifies Add access granted. - * - * @type {boolean} - * @memberof FileSystemSASPermissions */ public add: boolean = false; /** * Specifies Create access granted. - * - * @type {boolean} - * @memberof FileSystemSASPermissions */ public create: boolean = false; /** * Specifies Write access granted. - * - * @type {boolean} - * @memberof FileSystemSASPermissions */ public write: boolean = false; /** * Specifies Delete access granted. - * - * @type {boolean} - * @memberof FileSystemSASPermissions */ public delete: boolean = false; /** * Specifies List access granted. - * - * @type {boolean} - * @memberof FileSystemSASPermissions */ public list: boolean = false; /** * Specifies Move access granted. - * - * @type {boolean} - * @memberof DirectorySASPermissions */ public move: boolean = false; /** * Specifies Execute access granted. - * - * @type {boolean} - * @memberof DirectorySASPermissions */ public execute: boolean = false; @@ -132,18 +102,12 @@ export class FileSystemSASPermissions { * Specifies Ownership access granted, which allows the caller to set owner, owning group, * or act as the owner when renaming or deleting a blob (file or directory) within a folder * that has the sticky bit set. - * - * @type {boolean} - * @memberof DirectorySASPermissions */ public manageOwnership: boolean = false; /** * Specifies Permission access granted, which allows the caller to set permissions and * POSIX ACLs on blobs (files and directories). - * - * @type {boolean} - * @memberof DirectorySASPermissions */ public manageAccessControl: boolean = false; @@ -154,8 +118,6 @@ export class FileSystemSASPermissions { * The order of the characters should be as specified here to ensure correctness. * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas * - * - * @memberof FileSystemSASPermissions */ public toString(): string { const permissions: string[] = []; diff --git a/sdk/storage/storage-file-datalake/src/sas/SASQueryParameters.ts b/sdk/storage/storage-file-datalake/src/sas/SASQueryParameters.ts index 1597b965af2e..17543fd25680 100644 --- a/sdk/storage/storage-file-datalake/src/sas/SASQueryParameters.ts +++ b/sdk/storage/storage-file-datalake/src/sas/SASQueryParameters.ts @@ -6,9 +6,6 @@ import { truncatedISO8061Date } from "../utils/utils.common"; /** * Protocols for generated SAS. - * - * @export - * @enum {number} */ export enum SASProtocol { /** @@ -24,129 +21,78 @@ export enum SASProtocol { /** * Options to construct {@link SASQueryParameters}. - * - * @export - * @interface SASQueryParametersOptions */ export interface SASQueryParametersOptions { /** * Optional only when identifier is provided. * Please refer to {@link AccountSASPermissions}, {@link BlobSASPermissions}, or {@link ContainerSASPermissions} for * more details. - * - * @type {string} - * @memberof SASQueryParametersOptions */ permissions?: string; /** * Optional. The storage services being accessed (only for Account SAS). Please refer to {@link AccountSASServices} * for more details. - * - * @type {string} - * @memberof SASQueryParametersOptions */ services?: string; /** * Optional. The storage resource types being accessed (only for Account SAS). Please refer to * {@link AccountSASResourceTypes} for more details. - * - * @type {string} - * @memberof SASQueryParametersOptions */ resourceTypes?: string; /** * Optional. The allowed HTTP protocol(s). - * - * @type {SASProtocol} - * @memberof SASQueryParametersOptions */ protocol?: SASProtocol; /** * Optional. The start time for this SAS token. - * - * @type {Date} - * @memberof SASQueryParametersOptions */ startsOn?: Date; /** * Optional only when identifier is provided. The expiry time for this SAS token. - * - * @type {Date} - * @memberof SASQueryParametersOptions */ expiresOn?: Date; /** * Optional. IP ranges allowed in this SAS. - * - * @type {SasIPRange} - * @memberof SASQueryParametersOptions */ ipRange?: SasIPRange; /** * Optional. The signed identifier (only for {@link BlobSASSignatureValues}). * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy - * - * @type {string} - * @memberof SASQueryParametersOptions */ identifier?: string; /** * Optional. Specifies which resources are accessible via the SAS (only for {@link BlobSASSignatureValues}). * @see https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only - * - * @type {string} - * @memberof SASQueryParametersOptions */ resource?: string; /** * Value for cache-control header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParametersOptions */ cacheControl?: string; /** * Value for content-disposition header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParametersOptions */ contentDisposition?: string; /** * Value for content-encoding header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParametersOptions */ contentEncoding?: string; /** * Value for content-length header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParametersOptions */ contentLanguage?: string; /** * Value for content-type header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParametersOptions */ contentType?: string; /** * User delegation key properties. - * - * @type {UserDelegationKey} - * @memberof SASQueryParametersOptions */ userDelegationKey?: UserDelegationKey; /** * Indicate the depth of the directory specified in the canonicalizedresource field of the string-to-sign. * The depth of the directory is the number of directories beneath the root folder. - * - * @type {number} - * @memberof SASQueryParametersOptions */ directoryDepth?: number; /** @@ -155,26 +101,17 @@ export interface SASQueryParametersOptions { * has the required permissions before granting access but no additional permission check for the user specified in * this value will be performed. This cannot be used in conjuction with {@link signedUnauthorizedUserObjectId}. * This is only used for User Delegation SAS. - * - * @type {string} - * @memberof SASQueryParametersOptions */ preauthorizedAgentObjectId?: string; /** * Unauthorized AAD Object ID in GUID format. The AAD Object ID of a user that is assumed to be unauthorized by the owner of the User Delegation Key. * The Azure Storage Service will perform an additional POSIX ACL check to determine if the user is authorized to perform the requested operation. * This cannot be used in conjuction with {@link signedAuthorizedUserObjectId}. This is only used for User Delegation SAS. - * - * @type {string} - * @memberof SASQueryParametersOptions */ agentObjectId?: string; /** * A GUID value that will be logged in the storage diagnostic logs and can be used to correlate SAS generation with storage resource access. * This is only used for User Delegation SAS. - * - * @type {string} - * @memberof SASQueryParametersOptions */ correlationId?: string; } @@ -187,40 +124,25 @@ export interface SASQueryParametersOptions { * these query parameters). * * NOTE: Instances of this class are immutable. - * - * @export - * @class SASQueryParameters */ export class SASQueryParameters { /** * The storage API version. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly version: string; /** * Optional. The allowed HTTP protocol(s). - * - * @type {SASProtocol} - * @memberof SASQueryParameters */ public readonly protocol?: SASProtocol; /** * Optional. The start time for this SAS token. - * - * @type {Date} - * @memberof SASQueryParameters */ public readonly startsOn?: Date; /** * Optional only when identifier is provided. The expiry time for this SAS token. - * - * @type {Date} - * @memberof SASQueryParameters */ public readonly expiresOn?: Date; @@ -228,27 +150,18 @@ export class SASQueryParameters { * Optional only when identifier is provided. * Please refer to {@link AccountSASPermissions}, {@link BlobSASPermissions}, or {@link ContainerSASPermissions} for * more details. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly permissions?: string; /** * Optional. The storage services being accessed (only for Account SAS). Please refer to {@link AccountSASServices} * for more details. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly services?: string; /** * Optional. The storage resource types being accessed (only for Account SAS). Please refer to * {@link AccountSASResourceTypes} for more details. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly resourceTypes?: string; @@ -256,144 +169,89 @@ export class SASQueryParameters { * Optional. The signed identifier (only for {@link BlobSASSignatureValues}). * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy - * - * @type {string} - * @memberof SASQueryParameters */ public readonly identifier?: string; /** * Optional. Specifies which resources are accessible via the SAS (only for {@link BlobSASSignatureValues}). * @see https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only - * - * @type {string} - * @memberof SASQueryParameters */ public readonly resource?: string; /** * The signature for the SAS token. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly signature: string; /** * Value for cache-control header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly cacheControl?: string; /** * Value for content-disposition header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly contentDisposition?: string; /** * Value for content-encoding header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly contentEncoding?: string; /** * Value for content-length header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly contentLanguage?: string; /** * Value for content-type header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly contentType?: string; /** * Inner value of getter ipRange. - * - * @private - * @type {SasIPRange} - * @memberof SASQueryParameters */ private readonly ipRangeInner?: SasIPRange; /** * The Azure Active Directory object ID in GUID format. * Property of user delegation key. - * - * @private - * @type {string} - * @memberof SASQueryParameters */ private readonly signedOid?: string; /** * The Azure Active Directory tenant ID in GUID format. * Property of user delegation key. - * - * @private - * @type {string} - * @memberof SASQueryParameters */ private readonly signedTenantId?: string; /** * The date-time the key is active. * Property of user delegation key. - * - * @private - * @type {Date} - * @memberof SASQueryParameters */ private readonly signedStartsOn?: Date; /** * The date-time the key expires. * Property of user delegation key. - * - * @private - * @type {Date} - * @memberof SASQueryParameters */ private readonly signedExpiresOn?: Date; /** * Abbreviation of the Azure Storage service that accepts the user delegation key. * Property of user delegation key. - * - * @private - * @type {string} - * @memberof SASQueryParameters */ private readonly signedService?: string; /** * The service version that created the user delegation key. * Property of user delegation key. - * - * @private - * @type {string} - * @memberof SASQueryParameters */ private readonly signedVersion?: string; /** * Indicate the depth of the directory specified in the canonicalizedresource field of the string-to-sign. * The depth of the directory is the number of directories beneath the root folder. - * - * @type {number} - * @memberof SASQueryParameters */ public readonly directoryDepth?: number; @@ -403,9 +261,6 @@ export class SASQueryParameters { * has the required permissions before granting access but no additional permission check for the user specified in * this value will be performed. This cannot be used in conjuction with {@link signedUnauthorizedUserObjectId}. * This is only used for User Delegation SAS. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly preauthorizedAgentObjectId?: string; @@ -414,18 +269,12 @@ export class SASQueryParameters { * The Azure Storage Service will perform an additional POSIX ACL check to determine if the user is authorized to perform the requested operation. * This cannot be used in conjuction with {@link signedAuthorizedUserObjectId}. * This is only used for User Delegation SAS. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly agentObjectId?: string; /** * A GUID value that will be logged in the storage diagnostic logs and can be used to correlate SAS generation with storage resource access. * This is only used for User Delegation SAS. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly correlationId?: string; @@ -433,8 +282,6 @@ export class SASQueryParameters { * Optional. IP range allowed for this SAS. * * @readonly - * @type {(SasIPRange | undefined)} - * @memberof SASQueryParameters */ public get ipRange(): SasIPRange | undefined { if (this.ipRangeInner) { @@ -469,7 +316,6 @@ export class SASQueryParameters { * @param preauthorizedAgentObjectId - Representing the authorized AAD Object ID (only for User Delegation SAS) * @param agentObjectId - Representing the unauthorized AAD Object ID (only for User Delegation SAS) * @param correlationId - Representing the correlation ID (only for User Delegation SAS) - * @memberof SASQueryParameters */ constructor( version: string, @@ -501,7 +347,6 @@ export class SASQueryParameters { * @param version - Representing the storage version * @param signature - Representing the signature for the SAS token * @param options - Optional. Options to construct the SASQueryParameters. - * @memberof SASQueryParameters */ constructor(version: string, signature: string, options?: SASQueryParametersOptions); @@ -595,8 +440,6 @@ export class SASQueryParameters { /** * Encodes all SAS query parameters into a string that can be appended to a URL. * - * - * @memberof SASQueryParameters */ public toString(): string { const params: string[] = [ @@ -737,12 +580,9 @@ export class SASQueryParameters { /** * A private helper method used to filter and append query key/value pairs into an array. * - * @private * @param queries - * @param key - * @param value - - * - * @memberof SASQueryParameters */ private tryAppendQueryParameter(queries: string[], key: string, value?: string): void { if (!value) { diff --git a/sdk/storage/storage-file-datalake/src/sas/SasIPRange.ts b/sdk/storage/storage-file-datalake/src/sas/SasIPRange.ts index 08932c50e16b..516894476648 100644 --- a/sdk/storage/storage-file-datalake/src/sas/SasIPRange.ts +++ b/sdk/storage/storage-file-datalake/src/sas/SasIPRange.ts @@ -3,25 +3,16 @@ /** * Allowed IP range for a SAS. - * - * @export - * @interface SasIPRange */ export interface SasIPRange { /** * Starting IP address in the IP range. * If end IP doesn't provide, start IP will the only IP allowed. - * - * @type {string} - * @memberof SasIPRange */ start: string; /** * Optional. IP address that ends the IP range. * If not provided, start IP will the only IP allowed. - * - * @type {string} - * @memberof SasIPRange */ end?: string; } @@ -31,9 +22,7 @@ export interface SasIPRange { * * "8.8.8.8" or "1.1.1.1-255.255.255.255" * - * @export * @param ipRange - - * */ export function ipRangeToString(ipRange: SasIPRange): string { return ipRange.end ? `${ipRange.start}-${ipRange.end}` : ipRange.start; diff --git a/sdk/storage/storage-file-datalake/src/transforms.ts b/sdk/storage/storage-file-datalake/src/transforms.ts index 100b1fe22a91..790da25f449e 100644 --- a/sdk/storage/storage-file-datalake/src/transforms.ts +++ b/sdk/storage/storage-file-datalake/src/transforms.ts @@ -26,16 +26,14 @@ import { base64encode } from "./utils/utils.common"; * Only handle known host name pair patterns, add more patterns into ToBlobEndpointHostMappings in constants.ts. * * Expected input and outputs: - * http://account.blob.core.windows.net => http://account.blob.core.windows.net - * http://account.dfs.core.windows.net => http://account.blob.core.windows.net - * http://127.0.0.1:10000 => http://127.0.0.1:10000 - * http://account.blob.core.windows.net/abc => http://account.blob.core.windows.net/abc - * http://account.dfs.core.windows.net/abc => http://account.blob.core.windows.net/abc - * http://127.0.0.1:10000/abc => http://127.0.0.1:10000/abc + * http://account.blob.core.windows.net - http://account.blob.core.windows.net + * http://account.dfs.core.windows.net - http://account.blob.core.windows.net + * http://127.0.0.1:10000 - http://127.0.0.1:10000 + * http://account.blob.core.windows.net/abc - http://account.blob.core.windows.net/abc + * http://account.dfs.core.windows.net/abc - http://account.blob.core.windows.net/abc + * http://127.0.0.1:10000/abc - http://127.0.0.1:10000/abc * - * @export * @param url - - * */ export function toBlobEndpointUrl(url: string): string { const urlParsed = URLBuilder.parse(url); @@ -61,16 +59,14 @@ export function toBlobEndpointUrl(url: string): string { * Only handle known host name pair patterns, add more patterns into ToDfsEndpointHostMappings in constants.ts. * * Expected input and outputs: - * http://account.blob.core.windows.net => http://account.dfs.core.windows.net - * http://account.dfs.core.windows.net => http://account.dfs.core.windows.net - * http://127.0.0.1:10000 => http://127.0.0.1:10000 - * http://account.blob.core.windows.net/abc => http://account.dfs.core.windows.net/abc - * http://account.dfs.core.windows.net/abc => http://account.dfs.core.windows.net/abc - * http://127.0.0.1:10000/abc => http://127.0.0.1:10000/abc + * http://account.blob.core.windows.net - http://account.dfs.core.windows.net + * http://account.dfs.core.windows.net - http://account.dfs.core.windows.net + * http://127.0.0.1:10000 - http://127.0.0.1:10000 + * http://account.blob.core.windows.net/abc - http://account.dfs.core.windows.net/abc + * http://account.dfs.core.windows.net/abc - http://account.dfs.core.windows.net/abc + * http://127.0.0.1:10000/abc - http://127.0.0.1:10000/abc * - * @export * @param url - - * */ export function toDfsEndpointUrl(url: string): string { const urlParsed = URLBuilder.parse(url); diff --git a/sdk/storage/storage-file-datalake/src/utils/Batch.ts b/sdk/storage/storage-file-datalake/src/utils/Batch.ts index 7e3a6c9db40a..1e4bd121bcb9 100644 --- a/sdk/storage/storage-file-datalake/src/utils/Batch.ts +++ b/sdk/storage/storage-file-datalake/src/utils/Batch.ts @@ -12,8 +12,6 @@ export declare type Operation = () => Promise; /** * States for Batch. - * - * @enum {number} */ enum BatchStates { Good, @@ -24,78 +22,47 @@ enum BatchStates { * Batch provides basic parallel execution with concurrency limits. * Will stop execute left operations when one of the executed operation throws an error. * But Batch cannot cancel ongoing operations, you need to cancel them by yourself. - * - * @export - * @class Batch */ export class Batch { /** * Concurrency. Must be lager than 0. - * - * @type {number} - * @memberof Batch */ private concurrency: number; /** * Number of active operations under execution. - * - * @private - * @type {number} - * @memberof Batch */ private actives: number = 0; /** * Number of completed operations under execution. - * - * @private - * @type {number} - * @memberof Batch */ private completed: number = 0; /** * Offset of next operation to be executed. - * - * @private - * @type {number} - * @memberof Batch */ private offset: number = 0; /** * Operation array to be executed. - * - * @private - * @type {Operation[]} - * @memberof Batch */ private operations: Operation[] = []; /** * States of Batch. When an error happens, state will turn into error. * Batch will stop execute left operations. - * - * @private - * @type {BatchStates} - * @memberof Batch */ private state: BatchStates = BatchStates.Good; /** * A private emitter used to pass events inside this class. - * - * @private - * @type {EventEmitter} - * @memberof Batch */ private emitter: EventEmitter; /** * Creates an instance of Batch. * @param concurrency - - * @memberof Batch */ public constructor(concurrency: number = 5) { if (concurrency < 1) { @@ -109,7 +76,6 @@ export class Batch { * Add a operation into queue. * * @param operation - - * @memberof Batch */ public addOperation(operation: Operation): void { this.operations.push(async () => { @@ -128,8 +94,6 @@ export class Batch { /** * Start execute operations in the queue. * - * - * @memberof Batch */ public async do(): Promise { if (this.operations.length === 0) { @@ -150,9 +114,6 @@ export class Batch { /** * Get next operation to be executed. Return null when reaching ends. * - * @private - * - * @memberof Batch */ private nextOperation(): Operation | null { if (this.offset < this.operations.length) { @@ -165,9 +126,6 @@ export class Batch { * Start execute operations. One one the most important difference between * this method with do() is that do() wraps as an sync method. * - * @private - * - * @memberof Batch */ private parallelExecute(): void { if (this.state === BatchStates.Error) { diff --git a/sdk/storage/storage-file-datalake/src/utils/BufferScheduler.ts b/sdk/storage/storage-file-datalake/src/utils/BufferScheduler.ts index 6222b2a5c063..c3a03a6c80a0 100644 --- a/sdk/storage/storage-file-datalake/src/utils/BufferScheduler.ts +++ b/sdk/storage/storage-file-datalake/src/utils/BufferScheduler.ts @@ -21,7 +21,7 @@ export declare type OutgoingHandler = (buffer: Buffer, offset?: number) => Promi * * NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING * - * NUM_OF_ALL_BUFFERS <= maxBuffers + * NUM_OF_ALL_BUFFERS lesser than or equal to maxBuffers * * PERFORMANCE IMPROVEMENT TIPS: * 1. Input stream highWaterMark is better to set a same value with bufferSize @@ -30,117 +30,67 @@ export declare type OutgoingHandler = (buffer: Buffer, offset?: number) => Promi * reduce the possibility when a outgoing handler waits for the stream data. * in this situation, outgoing handlers are blocked. * Outgoing queue shouldn't be empty. - * @export - * @class BufferScheduler */ export class BufferScheduler { /** * Size of buffers in incoming and outgoing queues. This class will try to align * data read from Readable stream into buffer chunks with bufferSize defined. - * - * @private - * @type {number} - * @memberof BufferScheduler */ private readonly bufferSize: number; /** * How many buffers can be created or maintained. - * - * @private - * @type {number} - * @memberof BufferScheduler */ private readonly maxBuffers: number; /** * A Node.js Readable stream. - * - * @private - * @type {Readable} - * @memberof BufferScheduler */ private readonly readable: Readable; /** * OutgoingHandler is an async function triggered by BufferScheduler when there * are available buffers in outgoing array. - * - * @private - * @type {OutgoingHandler} - * @memberof BufferScheduler */ private readonly outgoingHandler: OutgoingHandler; /** * An internal event emitter. - * - * @private - * @type {EventEmitter} - * @memberof BufferScheduler */ private readonly emitter: EventEmitter = new EventEmitter(); /** - * Concurrency of executing outgoingHandlers. (0 < concurrency <= maxBuffers) - * - * @private - * @type {number} - * @memberof BufferScheduler + * Concurrency of executing outgoingHandlers. (0 lesser than concurrency lesser than or equal to maxBuffers) */ private readonly concurrency: number; /** * An internal offset marker to track data offset in bytes of next outgoingHandler. - * - * @private - * @type {number} - * @memberof BufferScheduler */ private offset: number = 0; /** * An internal marker to track whether stream is end. - * - * @private - * @type {boolean} - * @memberof BufferScheduler */ private isStreamEnd: boolean = false; /** * An internal marker to track whether stream or outgoingHandler returns error. - * - * @private - * @type {boolean} - * @memberof BufferScheduler */ private isError: boolean = false; /** * How many handlers are executing. - * - * @private - * @type {number} - * @memberof BufferScheduler */ private executingOutgoingHandlers: number = 0; /** * Encoding of the input Readable stream which has string data type instead of Buffer. - * - * @private - * @type {string} - * @memberof BufferScheduler */ private encoding?: string; /** * How many buffers have been allocated. - * - * @private - * @type {number} - * @memberof BufferScheduler */ private numBuffers: number = 0; @@ -150,37 +100,21 @@ export class BufferScheduler { * data received from the stream, when data in unresolvedDataArray exceeds the * blockSize defined, it will try to concat a blockSize of buffer, fill into available * buffers from incoming and push to outgoing array. - * - * @private - * @type {Buffer[]} - * @memberof BufferScheduler */ private unresolvedDataArray: Buffer[] = []; /** * How much data consisted in unresolvedDataArray. - * - * @private - * @type {number} - * @memberof BufferScheduler */ private unresolvedLength: number = 0; /** * The array includes all the available buffers can be used to fill data from stream. - * - * @private - * @type {Buffer[]} - * @memberof BufferScheduler */ private incoming: Buffer[] = []; /** * The array (queue) includes all the buffers filled from stream data. - * - * @private - * @type {Buffer[]} - * @memberof BufferScheduler */ private outgoing: Buffer[] = []; @@ -193,9 +127,8 @@ export class BufferScheduler { * @param outgoingHandler - An async function scheduled to be * triggered when a buffer fully filled * with stream data - * @param concurrency - Concurrency of executing outgoingHandlers (>0) + * @param concurrency - Concurrency of executing outgoingHandlers (greater than 0) * @param encoding - [Optional] Encoding of Readable stream when it's a string stream - * @memberof BufferScheduler */ constructor( readable: Readable, @@ -229,8 +162,6 @@ export class BufferScheduler { * Start the scheduler, will return error when stream of any of the outgoingHandlers * returns error. * - * - * @memberof BufferScheduler */ public async do(): Promise { return new Promise((resolve, reject) => { @@ -282,9 +213,7 @@ export class BufferScheduler { /** * Insert a new data into unresolved array. * - * @private * @param data - - * @memberof BufferScheduler */ private appendUnresolvedData(data: Buffer) { this.unresolvedDataArray.push(data); @@ -295,9 +224,6 @@ export class BufferScheduler { * Try to shift a buffer with size in blockSize. The buffer returned may be less * than blockSize when data in unresolvedDataArray is less than bufferSize. * - * @private - * - * @memberof BufferScheduler */ private shiftBufferFromUnresolvedDataArray(): Buffer { if (this.unresolvedLength >= this.bufferSize) { @@ -330,9 +256,7 @@ export class BufferScheduler { * * Return false when available buffers in incoming are not enough, else true. * - * @private * @returns Return false when buffers in incoming are not enough, else true. - * @memberof BufferScheduler */ private resolveData(): boolean { while (this.unresolvedLength >= this.bufferSize) { @@ -360,9 +284,6 @@ export class BufferScheduler { /** * Try to trigger a outgoing handler for every buffer in outgoing. Stop when * concurrency reaches. - * - * @private - * @memberof BufferScheduler */ private async triggerOutgoingHandlers() { let buffer: Buffer | undefined; @@ -381,10 +302,7 @@ export class BufferScheduler { /** * Trigger a outgoing handler for a buffer shifted from outgoing. * - * @private * @param buffer - - * - * @memberof BufferScheduler */ private async triggerOutgoingHandler(buffer: Buffer): Promise { const bufferLength = buffer.length; @@ -407,9 +325,7 @@ export class BufferScheduler { /** * Return buffer used by outgoing handler into incoming. * - * @private * @param buffer - - * @memberof BufferScheduler */ private reuseBuffer(buffer: Buffer) { this.incoming.push(buffer); diff --git a/sdk/storage/storage-file-datalake/src/utils/DataLakeAclChangeFailedError.ts b/sdk/storage/storage-file-datalake/src/utils/DataLakeAclChangeFailedError.ts index 3b65a013666f..111f3b092751 100644 --- a/sdk/storage/storage-file-datalake/src/utils/DataLakeAclChangeFailedError.ts +++ b/sdk/storage/storage-file-datalake/src/utils/DataLakeAclChangeFailedError.ts @@ -4,25 +4,15 @@ import { RestError } from "@azure/core-http"; /** * An error thrown when an operation is interrupted and can be continued later on. - * - * @export - * @class DataLakeAclChangeFailedError - * @extends {Error} */ export class DataLakeAclChangeFailedError extends Error { /** * Continuation token to continue next batch of operations. - * - * @type {string} - * @memberof DataLakeAclChangeFailedError */ public continuationToken?: string; /** * Internal error. - * - * @type {(RestError | Error)} - * @memberof DataLakeAclChangeFailedError */ public innerError: RestError | Error; diff --git a/sdk/storage/storage-file-datalake/src/utils/tracing.ts b/sdk/storage/storage-file-datalake/src/utils/tracing.ts index f2f2f51bd5fc..138c20f51c86 100644 --- a/sdk/storage/storage-file-datalake/src/utils/tracing.ts +++ b/sdk/storage/storage-file-datalake/src/utils/tracing.ts @@ -5,8 +5,8 @@ import { getTracer, SpanOptions, OperationTracingOptions } from "@azure/core-tra /** * Creates a span using the global tracer. - * @param name The name of the operation being performed. - * @param tracingOptions The options for the underlying http request. + * @param name - The name of the operation being performed. + * @param tracingOptions - The options for the underlying http request. */ export function createSpan( operationName: string, diff --git a/sdk/storage/storage-file-datalake/src/utils/utils.browser.ts b/sdk/storage/storage-file-datalake/src/utils/utils.browser.ts index 10e57bb89cda..cb4bb4e62344 100644 --- a/sdk/storage/storage-file-datalake/src/utils/utils.browser.ts +++ b/sdk/storage/storage-file-datalake/src/utils/utils.browser.ts @@ -4,9 +4,7 @@ /** * Convert a Browser Blob object into ArrayBuffer. * - * @export * @param blob - - * */ export async function blobToArrayBuffer(blob: Blob): Promise { const fileReader = new FileReader(); @@ -22,9 +20,7 @@ export async function blobToArrayBuffer(blob: Blob): Promise { /** * Convert a Browser Blob object into string. * - * @export * @param blob - - * */ export async function blobToString(blob: Blob): Promise { const fileReader = new FileReader(); diff --git a/sdk/storage/storage-file-datalake/src/utils/utils.common.ts b/sdk/storage/storage-file-datalake/src/utils/utils.common.ts index 5a05b72f8b3e..b18910abab2e 100644 --- a/sdk/storage/storage-file-datalake/src/utils/utils.common.ts +++ b/sdk/storage/storage-file-datalake/src/utils/utils.common.ts @@ -55,9 +55,7 @@ import { DevelopmentConnectionString, HeaderConstants, UrlConstants } from "./co * @see https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata * @see https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-shares--directories--files--and-metadata * - * @export * @param url - - * */ export function escapeURLPath(url: string): string { const urlParsed = URLBuilder.parse(url); @@ -118,7 +116,6 @@ export function getValueInConnString( /** * Extracts the parts of an Azure Storage account connection string. * - * @export * @param connectionString - Connection string. * @returns String key value pairs of the storage account's url and credentials. */ @@ -203,7 +200,6 @@ export function extractConnectionStringParts(connectionString: string): Connecti * Internal escape method implemented Strategy Two mentioned in escapeURL() description. * * @param text - - * */ function escape(text: string): string { return encodeURIComponent(text) @@ -217,7 +213,6 @@ function escape(text: string): string { * Append a string to URL path. Will remove duplicated "/" in front of the string * when URL path ends with a "/". * - * @export * @param url - Source URL string * @param name - String to be appended to URL * @returns An updated URL string @@ -235,7 +230,6 @@ export function appendToURLPath(url: string, name: string): string { /** * Append a string to URL query. * - * @export * @param url - Source URL string. * @param queryParts - String to be appended to the URL query. * @returns An updated URL string. @@ -258,7 +252,6 @@ export function appendToURLQuery(url: string, queryParts: string): string { * Set URL parameter name and value. If name exists in URL parameters, old value * will be replaced by name key. If not provide value, the parameter will be deleted. * - * @export * @param url - Source URL string * @param name - Parameter name * @param value - Parameter value @@ -273,10 +266,8 @@ export function setURLParameter(url: string, name: string, value?: string): stri /** * Get URL parameter by name. * - * @export * @param url - * @param name - - * */ export function getURLParameter(url: string, name: string): string | string[] | undefined { const urlParsed = URLBuilder.parse(url); @@ -286,7 +277,6 @@ export function getURLParameter(url: string, name: string): string | string[] | /** * Set URL host. * - * @export * @param url - Source URL string * @param host - New host string * @returns An updated URL string @@ -300,9 +290,7 @@ export function setURLHost(url: string, host: string): string { /** * Get URL path from an URL string. * - * @export * @param url - Source URL string - * */ export function getURLPath(url: string): string | undefined { const urlParsed = URLBuilder.parse(url); @@ -312,10 +300,8 @@ export function getURLPath(url: string): string | undefined { /** * Set URL path. * - * @export * @param url - * @param path - - * */ export function setURLPath(url: string, path?: string): string { const urlParsed = URLBuilder.parse(url); @@ -326,9 +312,7 @@ export function setURLPath(url: string, path?: string): string { /** * Get URL scheme from an URL string. * - * @export * @param url - Source URL string - * */ export function getURLScheme(url: string): string | undefined { const urlParsed = URLBuilder.parse(url); @@ -338,9 +322,7 @@ export function getURLScheme(url: string): string | undefined { /** * Get URL path and query from an URL string. * - * @export * @param url - Source URL string - * */ export function getURLPathAndQuery(url: string): string | undefined { const urlParsed = URLBuilder.parse(url); @@ -361,9 +343,7 @@ export function getURLPathAndQuery(url: string): string | undefined { /** * Get URL query key value pairs from an URL string. * - * @export * @param url - - * */ export function getURLQueries(url: string): { [key: string]: string } { let queryString = URLBuilder.parse(url).getQuery(); @@ -419,7 +399,6 @@ export function setURLQueries(url: string, queryString: string): string { /** * Rounds a date off to seconds. * - * @export * @param date - * @param withMilliseconds - If true, YYYY-MM-DDThh:mm:ss.fffffffZ will be returned; * If false, YYYY-MM-DDThh:mm:ssZ will be returned. @@ -437,9 +416,7 @@ export function truncatedISO8061Date(date: Date, withMilliseconds: boolean = tru /** * Base64 encode. * - * @export * @param content - - * */ export function base64encode(content: string): string { return !isNode ? btoa(content) : Buffer.from(content).toString("base64"); @@ -448,9 +425,7 @@ export function base64encode(content: string): string { /** * Base64 decode. * - * @export * @param encodedString - - * */ export function base64decode(encodedString: string): string { return !isNode ? atob(encodedString) : Buffer.from(encodedString, "base64").toString(); @@ -459,9 +434,7 @@ export function base64decode(encodedString: string): string { /** * Generate a 64 bytes base64 block ID string. * - * @export * @param blockIndex - - * */ export function generateBlockID(blockIDPrefix: string, blockIndex: number): string { // To generate a 64 bytes base64 string, source string should be 48 @@ -484,7 +457,6 @@ export function generateBlockID(blockIDPrefix: string, blockIndex: number): stri /** * Delay specified time interval. * - * @export * @param timeInMs - * @param aborter - * @param abortError - @@ -517,11 +489,9 @@ export async function delay(timeInMs: number, aborter?: AbortSignalLike, abortEr /** * String.prototype.padStart() * - * @export * @param currentString - * @param targetLength - - * @param [padString=" - "] - * + * @param padString - */ export function padStart( currentString: string, @@ -572,10 +542,8 @@ export function sanitizeHeaders(originalHeader: HttpHeaders): HttpHeaders { /** * If two strings are equal when compared case insensitive. * - * @export * @param str1 - * @param str2 - - * */ export function iEqual(str1: string, str2: string): boolean { return str1.toLocaleLowerCase() === str2.toLocaleLowerCase(); diff --git a/sdk/storage/storage-file-datalake/src/utils/utils.node.ts b/sdk/storage/storage-file-datalake/src/utils/utils.node.ts index d61b204fff48..7b56941c75bb 100644 --- a/sdk/storage/storage-file-datalake/src/utils/utils.node.ts +++ b/sdk/storage/storage-file-datalake/src/utils/utils.node.ts @@ -8,13 +8,11 @@ import { isNode } from "@azure/core-http"; /** * Reads a readable stream into buffer. Fill the buffer from offset to end. * - * @export * @param stream - A Node.js Readable stream - * @param buffer - Buffer to be filled, length must >= offset + * @param buffer - Buffer to be filled, length must greater than or equal to offset * @param offset - From which position in the buffer to be filled, inclusive * @param end - To which position in the buffer to be filled, exclusive * @param encoding - Encoding of the Readable stream - * */ export async function streamToBuffer( stream: NodeJS.ReadableStream, @@ -66,12 +64,11 @@ export async function streamToBuffer( /** * Reads a readable stream into buffer entirely. * - * @export * @param stream - A Node.js Readable stream - * @param buffer - Buffer to be filled, length must >= offset + * @param buffer - Buffer to be filled, length must greater than or equal to offset * @param encoding - Encoding of the Readable stream * @returns with the count of bytes read. - * @throws {RangeError} If buffer size is not big enough. + * @throws `RangeError` If buffer size is not big enough. */ export async function streamToBuffer2( stream: NodeJS.ReadableStream, diff --git a/sdk/storage/storage-file-datalake/test/utils/InjectorPolicy.ts b/sdk/storage/storage-file-datalake/test/utils/InjectorPolicy.ts index f7bc41bec26a..a4a7e192b413 100644 --- a/sdk/storage/storage-file-datalake/test/utils/InjectorPolicy.ts +++ b/sdk/storage/storage-file-datalake/test/utils/InjectorPolicy.ts @@ -18,9 +18,6 @@ export type Injector = () => RestError | undefined; /** * InjectorPolicy will inject a customized error before next HTTP request. - * - * @class InjectorPolicy - * @extends {BaseRequestPolicy} */ export class InjectorPolicy extends BaseRequestPolicy { /** @@ -28,7 +25,6 @@ export class InjectorPolicy extends BaseRequestPolicy { * * @param nextPolicy - * @param options - - * @memberof InjectorPolicy */ public constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, injector: Injector) { super(nextPolicy, options); @@ -39,8 +35,6 @@ export class InjectorPolicy extends BaseRequestPolicy { * Sends request. * * @param request - - * - * @memberof InjectorPolicy */ public async sendRequest(request: WebResource): Promise { const error = this.injector(); diff --git a/sdk/storage/storage-file-datalake/test/utils/InjectorPolicyFactory.ts b/sdk/storage/storage-file-datalake/test/utils/InjectorPolicyFactory.ts index 09fc932ec95d..b0c36c384558 100644 --- a/sdk/storage/storage-file-datalake/test/utils/InjectorPolicyFactory.ts +++ b/sdk/storage/storage-file-datalake/test/utils/InjectorPolicyFactory.ts @@ -6,10 +6,6 @@ import { InjectorPolicy, Injector } from "./InjectorPolicy"; /** * InjectorPolicyFactory is a factory class which injects customized errors for retry policy testing. - * - * @export - * @class InjectorPolicyFactory - * @implements {RequestPolicyFactory} */ export class InjectorPolicyFactory implements RequestPolicyFactory { public readonly injector: Injector; diff --git a/sdk/storage/storage-file-datalake/test/utils/index.browser.ts b/sdk/storage/storage-file-datalake/test/utils/index.browser.ts index 032b8173026b..7ecc77beb5ba 100644 --- a/sdk/storage/storage-file-datalake/test/utils/index.browser.ts +++ b/sdk/storage/storage-file-datalake/test/utils/index.browser.ts @@ -91,8 +91,8 @@ export function getAlternateDataLakeServiceClient(): DataLakeServiceClient { * Read body from downloading operation methods to string. * Works in both Node.js and browsers. * - * @param response Convenience layer methods response with downloaded body - * @param length Length of Readable stream, needed for Node.js environment + * @param response - Convenience layer methods response with downloaded body + * @param length - Length of Readable stream, needed for Node.js environment */ export async function bodyToString( response: { diff --git a/sdk/storage/storage-file-datalake/test/utils/index.ts b/sdk/storage/storage-file-datalake/test/utils/index.ts index b7e775999317..cf78354fa2e1 100644 --- a/sdk/storage/storage-file-datalake/test/utils/index.ts +++ b/sdk/storage/storage-file-datalake/test/utils/index.ts @@ -187,8 +187,8 @@ export function getAlternateDataLakeServiceClient(): DataLakeServiceClient { * Read body from downloading operation methods to string. * Works in both Node.js and browsers. * - * @param response Convenience layer methods response with downloaded body - * @param length Length of Readable stream, needed for Node.js environment + * @param response - Convenience layer methods response with downloaded body + * @param length - Length of Readable stream, needed for Node.js environment */ export async function bodyToString( response: { diff --git a/sdk/storage/storage-file-datalake/test/utils/testutils.common.ts b/sdk/storage/storage-file-datalake/test/utils/testutils.common.ts index c880265d5666..d9e0806561ad 100644 --- a/sdk/storage/storage-file-datalake/test/utils/testutils.common.ts +++ b/sdk/storage/storage-file-datalake/test/utils/testutils.common.ts @@ -83,8 +83,8 @@ export class SimpleTokenCredential implements TokenCredential { /** * Retrieves the token stored in this RawTokenCredential. * - * @param _scopes Ignored since token is already known. - * @param _options Ignored since token is already known. + * @param _scopes - Ignored since token is already known. + * @param _options - Ignored since token is already known. * @returns The access token details. */ async getToken( @@ -123,8 +123,8 @@ type BlobMetadata = { [propertyName: string]: string }; /** * Validate if m1 is super set of m2. * - * @param m1 BlobMetadata - * @param m2 BlobMetadata + * @param m1 - BlobMetadata + * @param m2 - BlobMetadata */ export function isSuperSet(m1?: BlobMetadata, m2?: BlobMetadata): boolean { if (!m1 || !m2) { diff --git a/sdk/storage/storage-file-datalake/test/utils/testutils.node.ts b/sdk/storage/storage-file-datalake/test/utils/testutils.node.ts index 743ad6092c24..c91fd7afb195 100644 --- a/sdk/storage/storage-file-datalake/test/utils/testutils.node.ts +++ b/sdk/storage/storage-file-datalake/test/utils/testutils.node.ts @@ -10,10 +10,8 @@ import * as fs from "fs"; * If Promise is rejected, the reason will be set to the first error raised by either the * ReadableStream or the fs.WriteStream. * - * @export * @param rs - The read stream. * @param file - Destination file path. - * */ export async function readStreamToLocalFileWithLogs( rs: NodeJS.ReadableStream, diff --git a/sdk/storage/storage-file-share/src/AccountSASPermissions.ts b/sdk/storage/storage-file-share/src/AccountSASPermissions.ts index b78d4366de64..018408a6964f 100644 --- a/sdk/storage/storage-file-share/src/AccountSASPermissions.ts +++ b/sdk/storage/storage-file-share/src/AccountSASPermissions.ts @@ -9,18 +9,12 @@ * values are set, this should be serialized with toString and set as the permissions field on an * {@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 - * @class AccountSASPermissions */ export class AccountSASPermissions { /** * Parse initializes the AccountSASPermissions fields from a string. * - * @static * @param permissions - - * - * @memberof AccountSASPermissions */ public static parse(permissions: string): AccountSASPermissions { const accountSASPermissions = new AccountSASPermissions(); @@ -61,65 +55,41 @@ export class AccountSASPermissions { /** * Permission to read resources and list queues and tables granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public read: boolean = false; /** * Permission to write resources granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public write: boolean = false; /** * Permission to delete blobs and files granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public delete: boolean = false; /** * Permission to list blob containers, blobs, shares, directories, and files granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public list: boolean = false; /** * Permission to add messages, table entities, and append to blobs granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public add: boolean = false; /** * Permission to create blobs and files granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public create: boolean = false; /** * Permissions to update messages and table entities granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public update: boolean = false; /** * Permission to get and delete messages granted. - * - * @type {boolean} - * @memberof AccountSASPermissions */ public process: boolean = false; @@ -132,8 +102,6 @@ export class AccountSASPermissions { * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas * - * - * @memberof AccountSASPermissions */ public toString(): string { // The order of the characters should be as specified here to ensure correctness: diff --git a/sdk/storage/storage-file-share/src/AccountSASResourceTypes.ts b/sdk/storage/storage-file-share/src/AccountSASResourceTypes.ts index ef9073af98be..05d984b8da05 100644 --- a/sdk/storage/storage-file-share/src/AccountSASResourceTypes.ts +++ b/sdk/storage/storage-file-share/src/AccountSASResourceTypes.ts @@ -9,19 +9,13 @@ * values are set, this should be serialized with toString and set as the resources field on an * {@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 - * @class AccountSASResourceTypes */ export class AccountSASResourceTypes { /** * Creates an {@link AccountSASResourceTypes} from the specified resource types string. This method will throw an * Error if it encounters a character that does not correspond to a valid resource type. * - * @static * @param resourceTypes - - * - * @memberof AccountSASResourceTypes */ public static parse(resourceTypes: string): AccountSASResourceTypes { const accountSASResourceTypes = new AccountSASResourceTypes(); @@ -47,25 +41,16 @@ export class AccountSASResourceTypes { /** * Permission to access service level APIs granted. - * - * @type {boolean} - * @memberof AccountSASResourceTypes */ public service: boolean = false; /** * Permission to access container level APIs (Blob Containers, Tables, Queues, File Shares) granted. - * - * @type {boolean} - * @memberof AccountSASResourceTypes */ public container: boolean = false; /** * Permission to access object level APIs (Blobs, Table Entities, Queue Messages, Files) granted. - * - * @type {boolean} - * @memberof AccountSASResourceTypes */ public object: boolean = false; @@ -74,8 +59,6 @@ export class AccountSASResourceTypes { * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas * - * - * @memberof AccountSASResourceTypes */ public toString(): string { const resourceTypes: string[] = []; diff --git a/sdk/storage/storage-file-share/src/AccountSASServices.ts b/sdk/storage/storage-file-share/src/AccountSASServices.ts index ac95ac984816..8129d39e354d 100644 --- a/sdk/storage/storage-file-share/src/AccountSASServices.ts +++ b/sdk/storage/storage-file-share/src/AccountSASServices.ts @@ -9,19 +9,13 @@ * values are set, this should be serialized with toString and set as the services field on an * {@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 - * @class AccountSASServices */ export class AccountSASServices { /** * Creates an {@link AccountSASServices} from the specified services string. This method will throw an * Error if it encounters a character that does not correspond to a valid service. * - * @static * @param services - - * - * @memberof AccountSASServices */ public static parse(services: string): AccountSASServices { const accountSASServices = new AccountSASServices(); @@ -50,41 +44,27 @@ export class AccountSASServices { /** * Permission to access blob resources granted. - * - * @type {boolean} - * @memberof AccountSASServices */ public blob: boolean = false; /** * Permission to access file resources granted. - * - * @type {boolean} - * @memberof AccountSASServices */ public file: boolean = false; /** * Permission to access queue resources granted. - * - * @type {boolean} - * @memberof AccountSASServices */ public queue: boolean = false; /** * Permission to access table resources granted. - * - * @type {boolean} - * @memberof AccountSASServices */ public table: boolean = false; /** * Converts the given services to a string. * - * - * @memberof AccountSASServices */ public toString(): string { const services: string[] = []; diff --git a/sdk/storage/storage-file-share/src/AccountSASSignatureValues.ts b/sdk/storage/storage-file-share/src/AccountSASSignatureValues.ts index d60375f9b860..d5afbe040cca 100644 --- a/sdk/storage/storage-file-share/src/AccountSASSignatureValues.ts +++ b/sdk/storage/storage-file-share/src/AccountSASSignatureValues.ts @@ -24,75 +24,48 @@ import { truncatedISO8061Date } from "./utils/utils.common"; * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas * for descriptions of the parameters, including which are required - * - * @export - * @class AccountSASSignatureValues */ export interface AccountSASSignatureValues { /** * If not provided, this defaults to the service version targeted by this version of the library. - * - * @type {string} - * @memberof AccountSASSignatureValues */ version?: string; /** * Optional. SAS protocols allowed. - * - * @type {SASProtocol} - * @memberof AccountSASSignatureValues */ protocol?: SASProtocol; /** * Optional. When the SAS will take effect. - * - * @type {Date} - * @memberof AccountSASSignatureValues */ startsOn?: Date; /** * The time after which the SAS will no longer work. - * - * @type {Date} - * @memberof AccountSASSignatureValues */ expiresOn: Date; /** * Specifies which operations the SAS user may perform. Please refer to {@link AccountSASPermissions} for help * constructing the permissions string. - * - * @type {AccountSASPermissions} - * @memberof AccountSASSignatureValues */ permissions: AccountSASPermissions; /** * Optional. IP range allowed. - * - * @type {SasIPRange} - * @memberof AccountSASSignatureValues */ ipRange?: SasIPRange; /** * The values that indicate the services accessible with this SAS. Please refer to {@link AccountSASServices} to * construct this value. - * - * @type {string} - * @memberof AccountSASSignatureValues */ services: string; /** * The values that indicate the resource types accessible with this SAS. Please refer * to {@link AccountSASResourceTypes} to construct this value. - * - * @type {string} - * @memberof AccountSASSignatureValues */ resourceTypes: string; } @@ -106,8 +79,6 @@ export interface AccountSASSignatureValues { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas * * @param sharedKeyCredential - - * - * @memberof AccountSASSignatureValues */ export function generateAccountSASQueryParameters( accountSASSignatureValues: AccountSASSignatureValues, diff --git a/sdk/storage/storage-file-share/src/Clients.ts b/sdk/storage/storage-file-share/src/Clients.ts index e09672205ae9..81f257efe3b8 100644 --- a/sdk/storage/storage-file-share/src/Clients.ts +++ b/sdk/storage/storage-file-share/src/Clients.ts @@ -114,333 +114,220 @@ import { FileSASPermissions } from "./FileSASPermissions"; /** * Options to configure the {@link ShareClient.create} operation. - * - * @export - * @interface ShareCreateOptions */ export interface ShareCreateOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ShareCreateOptions */ abortSignal?: AbortSignalLike; /** * A name-value pair to associate with a file storage object. - * - * @type {{ [propertyName: string]: string }} - * @memberof ShareCreateOptions */ metadata?: { [propertyName: string]: string }; /** * Specifies the maximum size of the share, in * gigabytes. - * - * @type {number} - * @memberof ShareCreateOptions */ quota?: number; /** * Specifies the access tier of the share. Possible values include: 'TransactionOptimized', * 'Hot', 'Cool' - * @type {ShareAccessTier} - * @memberof ShareCreateOptions */ accessTier?: ShareAccessTier; /** * Supported in version 2020-02-10 and above. Specifies the enabled protocols on the share. If not specified, the default is SMB. - * @type {ShareProtocols} - * @memberof ShareCreateOptions */ protocols?: ShareProtocols; /** * Root squash to set on the share. Only valid for NFS shares. Possible values include: * 'NoRootSquash', 'RootSquash', 'AllSquash'. - * @type {ShareRootSquash} - * @memberof ShareCreateOptions */ rootSquash?: ShareRootSquash; } /** * Options to configure the {@link ShareClient.delete} operation. - * - * @export - * @interface ShareDeleteMethodOptions */ export interface ShareDeleteMethodOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ShareDeleteMethodOptions */ abortSignal?: AbortSignalLike; /** * Specifies the option * include to delete the base share and all of its snapshots. Possible values * include: 'include' - * - * @type {DeleteSnapshotsOptionType} - * @memberof ShareDeleteMethodOptions */ deleteSnapshots?: DeleteSnapshotsOptionType; /** * If specified, the operation only succeeds if the resource's lease is active and matches this ID. - * - * @type {LeaseAccessConditions} - * @memberof ShareDeleteMethodOptions */ leaseAccessConditions?: LeaseAccessConditions; } /** * Options to configure the {@link ShareClient.setMetadata} operation. - * - * @export - * @interface ShareSetMetadataOptions */ export interface ShareSetMetadataOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ShareSetMetadataOptions */ abortSignal?: AbortSignalLike; /** * If specified, the operation only succeeds if the resource's lease is active and matches this ID. - * - * @type {LeaseAccessConditions} - * @memberof ShareSetMetadataOptions */ leaseAccessConditions?: LeaseAccessConditions; } /** * Options to configure the {@link ShareClient.setAccessPolicy} operation. - * - * @export - * @interface ShareSetAccessPolicyOptions */ export interface ShareSetAccessPolicyOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ShareSetAccessPolicyOptions */ abortSignal?: AbortSignalLike; /** * If specified, the operation only succeeds if the resource's lease is active and matches this ID. - * - * @type {LeaseAccessConditions} - * @memberof ShareSetAccessPolicyOptions */ leaseAccessConditions?: LeaseAccessConditions; } /** * Options to configure the {@link ShareClient.getAccessPolicy} operation. - * - * @export - * @interface ShareGetAccessPolicyOptions */ export interface ShareGetAccessPolicyOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ShareGetAccessPolicyOptions */ abortSignal?: AbortSignalLike; /** * If specified, the operation only succeeds if the resource's lease is active and matches this ID. - * - * @type {LeaseAccessConditions} - * @memberof ShareGetAccessPolicyOptions */ leaseAccessConditions?: LeaseAccessConditions; } /** * Options to configure the {@link ShareClient.exists} operation. - * - * @export - * @interface ShareExistsOptions */ export interface ShareExistsOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ShareExistsOptions */ abortSignal?: AbortSignalLike; /** * If specified, the operation only succeeds if the resource's lease is active and matches this ID. - * - * @type {LeaseAccessConditions} - * @memberof ShareExistsOptions */ leaseAccessConditions?: LeaseAccessConditions; } /** * Options to configure the {@link ShareClient.getProperties} operation. - * - * @export - * @interface ShareGetPropertiesOptions */ export interface ShareGetPropertiesOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ShareGetPropertiesOptions */ abortSignal?: AbortSignalLike; /** * If specified, the operation only succeeds if the resource's lease is active and matches this ID. - * - * @type {LeaseAccessConditions} - * @memberof ShareGetPropertiesOptions */ leaseAccessConditions?: LeaseAccessConditions; } /** * Options to configure the {@link ShareClient.setQuota} operation. - * - * @export - * @interface ShareSetQuotaOptions */ export interface ShareSetQuotaOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ShareSetQuotaOptions */ abortSignal?: AbortSignalLike; /** * If specified, the operation only succeeds if the resource's lease is active and matches this ID. - * - * @type {LeaseAccessConditions} - * @memberof ShareSetQuotaOptions */ leaseAccessConditions?: LeaseAccessConditions; } /** * Options to configure the {@link ShareClient.setProperties} operation. - * - * @export - * @interface ShareSetPropertiesOptions */ export interface ShareSetPropertiesOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ShareSetPropertiesOptions */ abortSignal?: AbortSignalLike; /** * Specifies the access tier of the share. Possible values include: 'TransactionOptimized', * 'Hot', 'Cool'. - * - * @type {ShareAccessTier} - * @memberof ShareSetPropertiesOptions */ accessTier?: ShareAccessTier; /** * Specifies the maximum size of the share, in gigabytes. - * @type {number} - * @memberof ShareSetPropertiesOptions */ quotaInGB?: number; /** * Root squash to set on the share. Only valid for NFS shares. Possible values include: * 'NoRootSquash', 'RootSquash', 'AllSquash'. - * @type {ShareRootSquash} - * @memberof ShareSetPropertiesOptions */ rootSquash?: ShareRootSquash; /** * If specified, the operation only succeeds if the resource's lease is active and matches this ID. - * - * @type {LeaseAccessConditions} - * @memberof ShareSetPropertiesOptions */ leaseAccessConditions?: LeaseAccessConditions; } /** * Options to configure the {@link ShareClient.getStatistics} operation. - * - * @export - * @interface ShareGetStatisticsOptions */ export interface ShareGetStatisticsOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ShareGetStatisticsOptions */ abortSignal?: AbortSignalLike; /** * If specified, the operation only succeeds if the resource's lease is active and matches this ID. - * - * @type {LeaseAccessConditions} - * @memberof ShareGetStatisticsOptions */ leaseAccessConditions?: LeaseAccessConditions; } /** * Signed Identifier - * - * @export - * @interface SignedIdentifier */ export interface SignedIdentifier { /** - * @member {string} id a unique id + * a unique id */ id: string; /** - * @member {AccessPolicy} accessPolicy */ accessPolicy: { /** - * @member {Date} startsOn the date-time the policy is active. + * the date-time the policy is active. */ startsOn: Date; /** - * @member {string} expiresOn the date-time the policy expires. + * the date-time the policy expires. */ expiresOn: Date; /** - * @member {string} permissions the permissions for the acl policy + * the permissions for the acl policy * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-share-acl */ permissions: string; @@ -471,66 +358,42 @@ export declare type ShareGetAccessPolicyResponse = { /** * Options to configure the {@link ShareClient.createSnapshot} operation. - * - * @export - * @interface ShareCreateSnapshotOptions */ export interface ShareCreateSnapshotOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ShareCreateSnapshotOptions */ abortSignal?: AbortSignalLike; /** * A name-value pair to associate with a file storage object. - * - * @type {{ [propertyName: string]: string }} - * @memberof ShareCreateOptions */ metadata?: { [propertyName: string]: string }; } /** * Options to configure the {@link ShareClient.createPermission} operation. - * - * @export - * @interface ShareCreatePermissionOptions */ export interface ShareCreatePermissionOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ShareCreatePermissionOptions */ abortSignal?: AbortSignalLike; } /** * Options to configure the {@link ShareClient.getPermission} operation. - * - * @export - * @interface ShareGetPermissionOptions */ export interface ShareGetPermissionOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ShareGetPermissionOptions */ abortSignal?: AbortSignalLike; } /** * Response data for the {@link ShareClient.getStatistics} Operation. - * - * @export - * @interface ShareGetStatisticsResponse */ export type ShareGetStatisticsResponse = ShareGetStatisticsResponseModel & { /** @@ -538,105 +401,67 @@ export type ShareGetStatisticsResponse = ShareGetStatisticsResponseModel & { * * The approximate size of the data stored on the share, rounded up to the nearest gigabyte. Note * that this value may not include all recently created or recently resized files. - * - * @type {number} - * @memberof ShareGetStatisticsResponse */ shareUsage: number; }; /** * Contains response data for the {@link ShareClient.createIfNotExists} operation. - * - * @export - * @interface ShareCreateIfNotExistsResponse */ export interface ShareCreateIfNotExistsResponse extends ShareCreateResponse { /** * Indicate whether the share is successfully created. Is false when the share is not changed as it already exists. - * - * @type {boolean} - * @memberof ShareCreateIfNotExistsResponse */ succeeded: boolean; } /** * Contains response data for the {@link ShareClient.deleteIfExists} operation. - * - * @export - * @interface ShareDeleteIfExistsResponse */ export interface ShareDeleteIfExistsResponse extends ShareDeleteResponse { /** * Indicate whether the share is successfully deleted. Is false if the share does not exist in the first place. - * - * @type {boolean} - * @memberof ShareDeleteIfExistsResponse */ succeeded: boolean; } /** * Contains response data for the {@link ShareClient.getProperties} operation. - * - * @export - * @interface ShareGetPropertiesResponse */ export type ShareGetPropertiesResponse = ShareGetPropertiesResponseModel & { /** * The protocols that have been enabled on the share. - * @type {ShareProtocols} - * @memberof ShareGetPropertiesResponse */ protocols?: ShareProtocols; }; /** * Common options of the {@link ShareGenerateSasUrlOptions} and {@link FileGenerateSasUrlOptions}. - * - * @export - * @interface CommonGenerateSasUrlOptions */ export interface CommonGenerateSasUrlOptions { /** * 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 CommonGenerateSasUrlOptions */ version?: string; /** * Optional. SAS protocols, HTTPS only or HTTPSandHTTP - * - * @type {SASProtocol} - * @memberof CommonGenerateSasUrlOptions */ protocol?: SASProtocol; /** * Optional. When the SAS will take effect. - * - * @type {Date} - * @memberof CommonGenerateSasUrlOptions */ startsOn?: Date; /** * Optional only when identifier is provided. The time after which the SAS will no longer work. - * - * @type {Date} - * @memberof CommonGenerateSasUrlOptions */ expiresOn?: Date; /** * Optional. IP ranges allowed in this SAS. - * - * @type {SasIPRange} - * @memberof CommonGenerateSasUrlOptions */ ipRange?: SasIPRange; @@ -644,82 +469,51 @@ export interface CommonGenerateSasUrlOptions { * Optional. The name of the access policy on the share this SAS references if any. * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy - * - * @type {string} - * @memberof CommonGenerateSasUrlOptions */ identifier?: string; /** * Optional. The cache-control header for the SAS. - * - * @type {string} - * @memberof CommonGenerateSasUrlOptions */ cacheControl?: string; /** * Optional. The content-disposition header for the SAS. - * - * @type {string} - * @memberof CommonGenerateSasUrlOptions */ contentDisposition?: string; /** * Optional. The content-encoding header for the SAS. - * - * @type {string} - * @memberof CommonGenerateSasUrlOptions */ contentEncoding?: string; /** * Optional. The content-language header for the SAS. - * - * @type {string} - * @memberof CommonGenerateSasUrlOptions */ contentLanguage?: string; /** * Optional. The content-type header for the SAS. - * - * @type {string} - * @memberof CommonGenerateSasUrlOptions */ contentType?: string; } /** * Options to configure {@link ShareClient.generateSasUrl} operation. - * - * @export - * @interface ShareGenerateSasUrlOptions */ export interface ShareGenerateSasUrlOptions extends CommonGenerateSasUrlOptions { /** * Optional only when identifier is provided. Specifies the list of permissions to be associated with the SAS. - * - * @type {ShareSASPermissions} - * @memberof ShareGenerateSasUrlOptions */ permissions?: ShareSASPermissions; } /** * A ShareClient represents a URL to the Azure Storage share allowing you to manipulate its directories and files. - * - * @export - * @class ShareClient */ export class ShareClient extends StorageClient { /** * Share operation context provided by protocol layer. - * - * @private - * @type {Share} - * @memberof ShareClient */ private context: Share; @@ -727,9 +521,6 @@ export class ShareClient extends StorageClient { /** * The name of the share - * - * @type {string} - * @memberof ShareClient */ public get name(): string { return this._name; @@ -744,7 +535,6 @@ export class ShareClient extends StorageClient { * `BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString` * @param name - Share name. * @param options - Optional. Options to configure the HTTP pipeline. - * @memberof ShareClient */ constructor(connectionString: string, name: string, options?: StoragePipelineOptions); /** @@ -757,7 +547,6 @@ export class ShareClient extends StorageClient { * @param credential - Such as AnonymousCredential or StorageSharedKeyCredential. * If not specified, AnonymousCredential is used. * @param options - Optional. Options to configure the HTTP pipeline. - * @memberof ShareClient */ constructor(url: string, credential?: Credential, options?: StoragePipelineOptions); /** @@ -769,7 +558,6 @@ export class ShareClient extends StorageClient { * "https://myaccount.file.core.windows.net/share?sasString". * @param pipeline - Call newPipeline() to create a default * pipeline, or provide a customized pipeline. - * @memberof ShareClient */ constructor(url: string, pipeline: Pipeline); constructor( @@ -835,7 +623,6 @@ export class ShareClient extends StorageClient { * * @param snapshot - The snapshot timestamp. * @returns A new ShareClient object identical to the source but with the specified snapshot timestamp - * @memberof ShareClient */ public withSnapshot(snapshot: string): ShareClient { return new ShareClient( @@ -855,7 +642,6 @@ export class ShareClient extends StorageClient { * * @param options - Options to Share Create operation. * @returns Response data for the Share Create operation. - * @memberof ShareClient */ public async create(options: ShareCreateOptions = {}): Promise { const { span, spanOptions } = createSpan("ShareClient-create", options.tracingOptions); @@ -882,8 +668,6 @@ export class ShareClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-share * * @param options - - * - * @memberof ShareClient */ public async createIfNotExists( options: ShareCreateOptions = {} @@ -926,9 +710,8 @@ export class ShareClient extends StorageClient { /** * Creates a {@link ShareDirectoryClient} object. * - * @param directoryName A directory name + * @param directoryName - A directory name * @returns The ShareDirectoryClient object for the given directory name. - * @memberof ShareClient */ public getDirectoryClient(directoryName: string): ShareDirectoryClient { return new ShareDirectoryClient( @@ -941,9 +724,7 @@ export class ShareClient extends StorageClient { * Gets the directory client for the root directory of this share. * Note that the root directory always exists and cannot be deleted. * - * @readonly - * @type {ShareDirectoryClient} A new ShareDirectoryClient object for the root directory. - * @memberof ShareClient + * @readonly A new ShareDirectoryClient object for the root directory. */ public get rootDirectoryClient(): ShareDirectoryClient { return this.getDirectoryClient(""); @@ -956,7 +737,6 @@ export class ShareClient extends StorageClient { * @param directoryName - * @param options - Options to Directory Create operation. * @returns Directory creation response data and the corresponding directory client. - * @memberof ShareClient */ public async createDirectory( directoryName: string, @@ -995,7 +775,6 @@ export class ShareClient extends StorageClient { * @param directoryName - * @param options - Options to Directory Delete operation. * @returns Directory deletion response data. - * @memberof ShareClient */ public async deleteDirectory( directoryName: string, @@ -1028,7 +807,6 @@ export class ShareClient extends StorageClient { * @param size - Specifies the maximum size in bytes for the file, up to 4 TB. * @param options - Options to File Create operation. * @returns File creation response data and the corresponding file client. - * @memberof ShareClient */ public async createFile( fileName: string, @@ -1077,7 +855,6 @@ export class ShareClient extends StorageClient { * @param fileName - * @param options - Options to File Delete operation. * @returns Promise File Delete response data. - * @memberof ShareClient */ public async deleteFile( fileName: string, @@ -1110,8 +887,6 @@ export class ShareClient extends StorageClient { * function completes. * * @param options - options to Exists operation. - * - * @memberof ShareClient */ public async exists(options: ShareExistsOptions = {}): Promise { const { span, spanOptions } = createSpan("ShareClient-exists", options.tracingOptions); @@ -1150,7 +925,6 @@ export class ShareClient extends StorageClient { * will retain their original casing. * * @returns Response data for the Share Get Properties operation. - * @memberof ShareClient */ public async getProperties( options: ShareGetPropertiesOptions = {} @@ -1184,7 +958,6 @@ export class ShareClient extends StorageClient { * * @param options - Options to Share Delete operation. * @returns Response data for the Share Delete operation. - * @memberof ShareClient */ public async delete(options: ShareDeleteMethodOptions = {}): Promise { const { span, spanOptions } = createSpan("ShareClient-delete", options.tracingOptions); @@ -1210,8 +983,6 @@ export class ShareClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share * * @param options - - * - * @memberof ShareClient */ public async deleteIfExists( options: ShareDeleteMethodOptions = {} @@ -1258,7 +1029,6 @@ export class ShareClient extends StorageClient { * @param metadata - If no metadata provided, all existing directory metadata will be removed. * @param option - Options to Share Set Metadata operation. * @returns Response data for the Share Set Metadata operation. - * @memberof ShareClient */ public async setMetadata( metadata?: Metadata, @@ -1293,7 +1063,6 @@ export class ShareClient extends StorageClient { * * @param option - Options to Share Get Access Policy operation. * @returns Response data for the Share Get Access Policy operation. - * @memberof ShareClient */ public async getAccessPolicy( options: ShareGetAccessPolicyOptions = {} @@ -1365,7 +1134,6 @@ export class ShareClient extends StorageClient { * @param shareAcl - Array of signed identifiers, each having a unique Id and details of access policy. * @param option - Options to Share Set Access Policy operation. * @returns Response data for the Share Set Access Policy operation. - * @memberof ShareClient */ public async setAccessPolicy( shareAcl?: SignedIdentifier[], @@ -1410,7 +1178,6 @@ export class ShareClient extends StorageClient { * * @param options - Options to Share Create Snapshot operation. * @returns Response data for the Share Create Snapshot operation. - * @memberof ShareClient */ public async createSnapshot( options: ShareCreateSnapshotOptions = {} @@ -1441,7 +1208,6 @@ export class ShareClient extends StorageClient { * @param quotaInGB - Specifies the maximum size of the share in gigabytes * @param option - Options to Share Set Quota operation. * @returns Response data for the Share Get Quota operation. - * @memberof ShareClient */ public async setQuota( quotaInGB: number, @@ -1470,7 +1236,6 @@ export class ShareClient extends StorageClient { * * @param option - Options to Share Set Properties operation. * @returns Response data for the Share Set Properties operation. - * @memberof ShareClient */ public async setProperties( options: ShareSetPropertiesOptions = {} @@ -1498,7 +1263,6 @@ export class ShareClient extends StorageClient { * * @param option - Options to Share Get Statistics operation. * @returns Response data for the Share Get Statistics operation. - * @memberof ShareClient */ public async getStatistics( options: ShareGetStatisticsOptions = {} @@ -1529,7 +1293,7 @@ export class ShareClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-permission * * @param options - Options to Share Create Permission operation. - * @param filePermission File permission described in the SDDL + * @param filePermission - File permission described in the SDDL */ public async createPermission( filePermission: string, @@ -1566,7 +1330,7 @@ export class ShareClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-permission * * @param options - Options to Share Create Permission operation. - * @param filePermissionKey File permission key which indicates the security descriptor of the permission. + * @param filePermissionKey - File permission key which indicates the security descriptor of the permission. */ public async getPermission( filePermissionKey: string, @@ -1599,7 +1363,6 @@ export class ShareClient extends StorageClient { * * @param options - Optional parameters. * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token. - * @memberof ShareClient */ public generateSasUrl(options: ShareGenerateSasUrlOptions): string { if (!(this.credential instanceof StorageSharedKeyCredential)) { @@ -1622,24 +1385,15 @@ export class ShareClient extends StorageClient { /** * Options to configure {@link ShareDirectoryClient.create} operation. - * - * @export - * @interface DirectoryCreateOptions */ export interface DirectoryCreateOptions extends FileAndDirectoryCreateCommonOptions, CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof DirectoryCreateOptions */ abortSignal?: AbortSignalLike; /** * A collection of key-value string pair to associate with the file storage object. - * - * @type {Metadata} - * @memberof DirectoryCreateOptions */ metadata?: Metadata; } @@ -1650,9 +1404,6 @@ export interface DirectoryProperties /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof DirectoryProperties */ abortSignal?: AbortSignalLike; } @@ -1664,24 +1415,16 @@ export interface DirectoryProperties * - {@link ShareDirectoryClient.iterateFilesAndDirectoriesSegments} * - {@link ShareDirectoryClient.listFilesAndDirectoriesItems} * - {@link ShareDirectoryClient.listFilesAndDirectoriesSegment} - * - * @interface DirectoryListFilesAndDirectoriesSegmentOptions */ interface DirectoryListFilesAndDirectoriesSegmentOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof DirectoryListFilesAndDirectoriesSegmentOptions */ abortSignal?: AbortSignalLike; /** * Filters the results to return only entries whose * name begins with the specified prefix. - * - * @type {string} - * @memberof DirectoryListFilesAndDirectoriesSegmentOptions */ prefix?: string; @@ -1689,102 +1432,66 @@ interface DirectoryListFilesAndDirectoriesSegmentOptions extends CommonOptions { * Specifies the maximum number of entries to * return. If the request does not specify maxResults, or specifies a value * greater than 5,000, the server will return up to 5,000 items. - * - * @type {number} - * @memberof DirectoryListFilesAndDirectoriesSegmentOptions */ maxResults?: number; } /** * Options to configure {@link ShareDirectoryClient.listFilesAndDirectories} operation. - * - * @export - * @interface DirectoryListFilesAndDirectoriesOptions */ export interface DirectoryListFilesAndDirectoriesOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof DirectoryListFilesAndDirectoriesOptions */ abortSignal?: AbortSignalLike; /** * Filters the results to return only entries whose * name begins with the specified prefix. - * - * @type {string} - * @memberof DirectoryListFilesAndDirectoriesOptions */ prefix?: string; } /** * Options to configure the {@link ShareDirectoryClient.delete} operation. - * - * @export - * @interface DirectoryDeleteOptions */ export interface DirectoryDeleteOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof DirectoryDeleteOptions */ abortSignal?: AbortSignalLike; } /** * Options to configure the {@link ShareDirectoryClient.exists} operation. - * - * @export - * @interface DirectoryExistsOptions */ export interface DirectoryExistsOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof DirectoryExistsOptions */ abortSignal?: AbortSignalLike; } /** * Options to configure the {@link ShareDirectoryClient.getProperties} operation. - * - * @export - * @interface DirectoryGetPropertiesOptions */ export interface DirectoryGetPropertiesOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof DirectoryGetPropertiesOptions */ abortSignal?: AbortSignalLike; } /** * Options to configure the {@link ShareDirectoryClient.setMetadata} operation. - * - * @export - * @interface DirectorySetMetadataOptions */ export interface DirectorySetMetadataOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof DirectorySetMetadataOptions */ abortSignal?: AbortSignalLike; } @@ -1797,58 +1504,37 @@ export interface DirectorySetMetadataOptions extends CommonOptions { * - {@link ShareDirectoryClient.iterateHandleSegments} * - {@link ShareDirectoryClient.listHandleItems} * - * - * @export - * @interface DirectoryListHandlesSegmentOptions */ export interface DirectoryListHandlesSegmentOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof DirectoryListHandlesSegmentOptions */ abortSignal?: AbortSignalLike; /** * Specifies the maximum number of entries to return. If the request does not specify maxResults, * or specifies a value greater than 5,000, the server will return up to 5,000 items. - * - * @type {number} - * @memberof DirectoryListHandlesSegmentOptions */ maxResults?: number; /** * Specifies operation should apply to the directory specified in the URI, its files, its * subdirectories and their files. - * - * @type {boolean} - * @memberof DirectoryListHandlesSegmentOptions */ recursive?: boolean; } /** * Options to configure the {@link ShareDirectoryClient.listHandles} operation. - * - * @export - * @interface DirectoryListHandlesOptions */ export interface DirectoryListHandlesOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof DirectoryListHandlesOptions */ abortSignal?: AbortSignalLike; /** * Specifies whether operation should apply to the directory specified in the URI, its files, its * subdirectories and their files. - * - * @type {boolean} - * @memberof DirectoryListHandlesOptions */ recursive?: boolean; } @@ -1859,25 +1545,16 @@ export interface DirectoryListHandlesOptions extends CommonOptions { * See: * - {@link ShareDirectoryClient.forceCloseHandlesSegment} * - {@link ShareDirectoryClient.forceCloseAllHandles} - * - * @export - * @interface DirectoryForceCloseHandlesSegmentOptions */ export interface DirectoryForceCloseHandlesSegmentOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof DirectoryForceCloseHandlesSegmentOptions */ abortSignal?: AbortSignalLike; /** * Specifies operation should apply to the directory specified in the URI, its files, its * subdirectories and their files. - * - * @type {boolean} - * @memberof DirectoryForceCloseHandlesSegmentOptions */ recursive?: boolean; } @@ -1925,66 +1602,41 @@ export type DirectoryForceCloseHandlesResponse = CloseHandlesInfo & /** * Options to configure {@link ShareDirectoryClient.forceCloseHandle}. - * - * @export - * @interface DirectoryForceCloseHandlesOptions */ export interface DirectoryForceCloseHandlesOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof DirectoryForceCloseHandlesOptions */ abortSignal?: AbortSignalLike; } /** * Contains response data for the {@link DirectoryClient.createIfNotExists} operation. - * - * @export - * @interface DirectoryCreateIfNotExistsResponse */ export interface DirectoryCreateIfNotExistsResponse extends DirectoryCreateResponse { /** * Indicate whether the directory is successfully created. Is false when the directory is not changed as it already exists. - * - * @type {boolean} - * @memberof DirectoryCreateIfNotExistsResponse */ succeeded: boolean; } /** * Contains response data for the {@link DirectoryClient.deleteIfExists} operation. - * - * @export - * @interface DirectoryDeleteIfExistsResponse */ export interface DirectoryDeleteIfExistsResponse extends DirectoryDeleteResponse { /** * Indicate whether the directory is successfully deleted. Is false if the directory does not exist in the first place. - * - * @type {boolean} - * @memberof DirectoryDeleteIfExistsResponse */ succeeded: boolean; } /** * A ShareDirectoryClient represents a URL to the Azure Storage directory allowing you to manipulate its files and directories. - * - * @export - * @class ShareDirectoryClient */ export class ShareDirectoryClient extends StorageClient { /** * context provided by protocol layer. - * - * @private - * @type {Directory} - * @memberof ShareDirectoryClient */ private context: Directory; @@ -1994,9 +1646,6 @@ export class ShareDirectoryClient extends StorageClient { /** * The share name corresponding to this directory client - * - * @type {string} - * @memberof ShareDirectoryClient */ public get shareName(): string { return this._shareName; @@ -2004,9 +1653,6 @@ export class ShareDirectoryClient extends StorageClient { /** * The full path of the directory - * - * @type {string} - * @memberof ShareDirectoryClient */ public get path(): string { return this._path; @@ -2014,9 +1660,6 @@ export class ShareDirectoryClient extends StorageClient { /** * The name of the directory - * - * @type {string} - * @memberof ShareDirectoryClient */ public get name(): string { return this._name; @@ -2036,7 +1679,6 @@ export class ShareDirectoryClient extends StorageClient { * @param credential - Such as AnonymousCredential or StorageSharedKeyCredential. * If not specified, AnonymousCredential is used. * @param options - Optional. Options to configure the HTTP pipeline. - * @memberof ShareDirectoryClient */ constructor(url: string, credential?: Credential, options?: StoragePipelineOptions); /** @@ -2052,7 +1694,6 @@ export class ShareDirectoryClient extends StorageClient { * Such as a directory named "mydir%", the URL should be "https://myaccount.file.core.windows.net/myshare/mydir%25". * @param pipeline - Call newPipeline() to create a default * pipeline, or provide a customized pipeline. - * @memberof ShareDirectoryClient */ constructor(url: string, pipeline: Pipeline); constructor( @@ -2085,7 +1726,6 @@ export class ShareDirectoryClient extends StorageClient { * * @param options - Options to Directory Create operation. * @returns Response data for the Directory operation. - * @memberof ShareDirectoryClient */ public async create(options: DirectoryCreateOptions = {}): Promise { const { span, spanOptions } = createSpan("ShareDirectoryClient-create", options.tracingOptions); @@ -2127,8 +1767,6 @@ export class ShareDirectoryClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory * * @param options - - * - * @memberof ShareDirectoryClient */ public async createIfNotExists( options: DirectoryCreateOptions = {} @@ -2174,8 +1812,6 @@ export class ShareDirectoryClient extends StorageClient { * * @param DirectoryProperties - Directory properties. If no values are provided, * existing values will be preserved. - * - * @memberof ShareDirectoryClient */ public async setProperties( properties: DirectoryProperties = {} @@ -2212,9 +1848,8 @@ export class ShareDirectoryClient extends StorageClient { /** * Creates a ShareDirectoryClient object for a sub directory. * - * @param subDirectoryName A subdirectory name + * @param subDirectoryName - A subdirectory name * @returns The ShareDirectoryClient object for the given subdirectory name. - * @memberof ShareDirectoryClient * * Example usage: * @@ -2238,7 +1873,6 @@ export class ShareDirectoryClient extends StorageClient { * @param directoryName - * @param options - Options to Directory Create operation. * @returns Directory create response data and the corresponding DirectoryClient instance. - * @memberof ShareDirectoryClient */ public async createSubdirectory( directoryName: string, @@ -2280,7 +1914,6 @@ export class ShareDirectoryClient extends StorageClient { * @param directoryName - * @param options - Options to Directory Delete operation. * @returns Directory deletion response data. - * @memberof ShareDirectoryClient */ public async deleteSubdirectory( directoryName: string, @@ -2315,7 +1948,6 @@ export class ShareDirectoryClient extends StorageClient { * @param size - Specifies the maximum size in bytes for the file, up to 4 TB. * @param options - Options to File Create operation. * @returns File creation response data and the corresponding file client. - * @memberof ShareDirectoryClient */ public async createFile( fileName: string, @@ -2364,7 +1996,6 @@ export class ShareDirectoryClient extends StorageClient { * @param fileName - Name of the file to delete * @param options - Options to File Delete operation. * @returns File deletion response data. - * @memberof ShareDirectoryClient */ public async deleteFile( fileName: string, @@ -2396,7 +2027,6 @@ export class ShareDirectoryClient extends StorageClient { * * @param fileName - A file name. * @returns A new ShareFileClient object for the given file name. - * @memberof ShareFileClient * * Example usage: * @@ -2427,8 +2057,6 @@ export class ShareDirectoryClient extends StorageClient { * function completes. * * @param options - options to Exists operation. - * - * @memberof ShareDirectoryClient */ public async exists(options: DirectoryExistsOptions = {}): Promise { const { span, spanOptions } = createSpan("ShareDirectoryClient-exists", options.tracingOptions); @@ -2467,7 +2095,6 @@ export class ShareDirectoryClient extends StorageClient { * * @param options - Options to Directory Get Properties operation. * @returns Response data for the Directory Get Properties operation. - * @memberof ShareDirectoryClient */ public async getProperties( options: DirectoryGetPropertiesOptions = {} @@ -2499,7 +2126,6 @@ export class ShareDirectoryClient extends StorageClient { * * @param options - Options to Directory Delete operation. * @returns Response data for the Directory Delete operation. - * @memberof ShareDirectoryClient */ public async delete(options: DirectoryDeleteOptions = {}): Promise { const { span, spanOptions } = createSpan("ShareDirectoryClient-delete", options.tracingOptions); @@ -2525,8 +2151,6 @@ export class ShareDirectoryClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-directory * * @param options - - * - * @memberof ShareDirectoryClient */ public async deleteIfExists( options: DirectoryDeleteOptions = {} @@ -2576,7 +2200,6 @@ export class ShareDirectoryClient extends StorageClient { * @param metadata - If no metadata provided, all existing directory metadata will be removed * @param options - Options to Directory Set Metadata operation. * @returns Response data for the Directory Set Metadata operation. - * @memberof ShareDirectoryClient */ public async setMetadata( metadata?: Metadata, @@ -2606,7 +2229,6 @@ export class ShareDirectoryClient extends StorageClient { /** * Returns an AsyncIterableIterator for {@link DirectoryListFilesAndDirectoriesSegmentResponse} objects * - * @private * @param marker - A string value that identifies the portion of * the list of files and directories to be returned with the next listing operation. The * operation returns the ContinuationToken value within the response body if the @@ -2615,8 +2237,6 @@ export class ShareDirectoryClient extends StorageClient { * the marker parameter in a subsequent call to request the next page of list * items. The marker value is opaque to the client. * @param options - Options to list files and directories operation. - * - * @memberof ShareDirectoryClient */ private async *iterateFilesAndDirectoriesSegments( marker?: string, @@ -2637,10 +2257,7 @@ export class ShareDirectoryClient extends StorageClient { /** * Returns an AsyncIterableIterator for file and directory items * - * @private * @param options - Options to list files and directories operation. - * @returns & DirectoryItem>} - * @memberof ShareDirectoryClient */ private async *listFilesAndDirectoriesItems( options: DirectoryListFilesAndDirectoriesSegmentOptions = {} @@ -2753,9 +2370,7 @@ export class ShareDirectoryClient extends StorageClient { * ``` * * @param options - Options to list files and directories operation. - * @memberof ShareDirectoryClient - * @returns , DirectoryListFilesAndDirectoriesSegmentResponse>} - * An asyncIterableIterator that supports paging. + * @returns An asyncIterableIterator that supports paging. */ public listFilesAndDirectories( options: DirectoryListFilesAndDirectoriesOptions = {} @@ -2771,19 +2386,19 @@ export class ShareDirectoryClient extends StorageClient { const iter = this.listFilesAndDirectoriesItems(options); return { /** - * @member {Promise} [next] The next method, part of the iteration protocol + * The next method, part of the iteration protocol */ async next() { return iter.next(); }, /** - * @member {Symbol} [asyncIterator] The connection to the async iterator, part of the iteration protocol + * The connection to the async iterator, part of the iteration protocol */ [Symbol.asyncIterator]() { return this; }, /** - * @member {Function} [byPage] Return an AsyncIterableIterator that works a page at a time + * Return an AsyncIterableIterator that works a page at a time */ byPage: (settings: PageSettings = {}) => { return this.iterateFilesAndDirectoriesSegments(settings.continuationToken, { @@ -2802,7 +2417,6 @@ export class ShareDirectoryClient extends StorageClient { * @param marker - A string value that identifies the portion of the list to be returned with the next list operation. * @param options - Options to Directory List Files and Directories Segment operation. * @returns Response data for the Directory List Files and Directories operation. - * @memberof ShareDirectoryClient */ private async listFilesAndDirectoriesSegment( marker?: string, @@ -2837,15 +2451,12 @@ export class ShareDirectoryClient extends StorageClient { /** * Returns an AsyncIterableIterator for {@link DirectoryListHandlesResponse} * - * @private * @param marker - A string value that identifies the portion of the list to be * returned with the next list handles operation. The operation returns a * marker value within the response body if the list returned was not complete. * The marker value may then be used in a subsequent call to request the next * set of list items. * @param options - Options to list handles operation. - * - * @memberof ShareDirectoryClient */ private async *iterateHandleSegments( marker?: string, @@ -2864,10 +2475,7 @@ export class ShareDirectoryClient extends StorageClient { /** * Returns an AsyncIterableIterator for handles * - * @private * @param options - Options to list handles operation. - * - * @memberof ShareDirectoryClient */ private async *listHandleItems( options: DirectoryListHandlesSegmentOptions = {} @@ -2955,7 +2563,6 @@ export class ShareDirectoryClient extends StorageClient { * ``` * * @param options - Options to list handles operation. - * @memberof ShareDirectoryClient * * An asyncIterableIterator that supports paging. */ @@ -2966,19 +2573,19 @@ export class ShareDirectoryClient extends StorageClient { const iter = this.listHandleItems(options); return { /** - * @member {Promise} [next] The next method, part of the iteration protocol + * The next method, part of the iteration protocol */ async next() { return iter.next(); }, /** - * @member {Symbol} [asyncIterator] The connection to the async iterator, part of the iteration protocol + * The connection to the async iterator, part of the iteration protocol */ [Symbol.asyncIterator]() { return this; }, /** - * @member {Function} [byPage] Return an AsyncIterableIterator that works a page at a time + * Return an AsyncIterableIterator that works a page at a time */ byPage: (settings: PageSettings = {}) => { return this.iterateHandleSegments(settings.continuationToken, { @@ -2999,8 +2606,6 @@ export class ShareDirectoryClient extends StorageClient { * The marker value may then be used in a subsequent call to request the next * set of list items. * @param options - - * - * @memberof ShareDirectoryClient */ private async listHandlesSegment( marker?: string, @@ -3045,8 +2650,6 @@ export class ShareDirectoryClient extends StorageClient { * body if there are more handles to close. The marker value * may then be used in a subsequent call to close the next set of handles. * @param options - - * - * @memberof ShareDirectoryClient */ private async forceCloseHandlesSegment( marker?: string, @@ -3083,8 +2686,6 @@ export class ShareDirectoryClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/force-close-handles * * @param options - - * - * @memberof ShareDirectoryClient */ public async forceCloseAllHandles( options: DirectoryForceCloseHandlesSegmentOptions = {} @@ -3129,8 +2730,6 @@ export class ShareDirectoryClient extends StorageClient { * @param handleId - Specific handle ID, cannot be asterisk "*". * Use forceCloseHandlesSegment() to close all handles. * @param options - - * - * @memberof ShareDirectoryClient */ public async forceCloseHandle( handleId: string, @@ -3169,39 +2768,24 @@ export class ShareDirectoryClient extends StorageClient { /** * Options to configure the {@link ShareFileClient.create} operation. - * - * @export - * @interface FileCreateOptions */ export interface FileCreateOptions extends FileAndDirectoryCreateCommonOptions, CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileCreateOptions */ abortSignal?: AbortSignalLike; /** * File HTTP headers like Content-Type. - * - * @type {FileHttpHeaders} - * @memberof FileCreateOptions */ fileHttpHeaders?: FileHttpHeaders; /** * A collection of key-value string pair to associate with the file storage object. - * - * @type {Metadata} - * @memberof FileCreateOptions */ metadata?: Metadata; /** * Lease access conditions. - * - * @type {LeaseAccessConditions} - * @memberof FileCreateOptions */ leaseAccessConditions?: LeaseAccessConditions; } @@ -3210,23 +2794,14 @@ export interface FileProperties extends FileAndDirectorySetPropertiesCommonOptio /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileProperties */ abortSignal?: AbortSignalLike; /** * File HTTP headers like Content-Type. - * - * @type {FileHttpHeaders} - * @memberof FileProperties */ fileHttpHeaders?: FileHttpHeaders; /** * Lease access conditions. - * - * @type {LeaseAccessConditions} - * @memberof FileProperties */ leaseAccessConditions?: LeaseAccessConditions; } @@ -3235,24 +2810,15 @@ export interface SetPropertiesResponse extends FileSetHTTPHeadersResponse {} /** * Options to configure the {@link ShareFileClient.delete} operation. - * - * @export - * @interface FileDeleteOptions */ export interface FileDeleteOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileDeleteOptions */ abortSignal?: AbortSignalLike; /** * Lease access conditions. - * - * @type {LeaseAccessConditions} - * @memberof FileDeleteOptions */ leaseAccessConditions?: LeaseAccessConditions; } @@ -3263,17 +2829,11 @@ export interface FileDeleteOptions extends CommonOptions { * See: * - {@link ShareFileClient.download} * - {@link ShareFileClient.downloadToFile} - * - * @export - * @interface FileDownloadOptions */ export interface FileDownloadOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileDownloadOptions */ abortSignal?: AbortSignalLike; /** @@ -3287,9 +2847,6 @@ export interface FileDownloadOptions extends CommonOptions { * from the broken point, until the requested range has been successfully downloaded or maxRetryRequests is reached. * * Default value is 5, please set a larger value when loading large files in poor network. - * - * @type {number} - * @memberof FileDownloadOptions */ maxRetryRequests?: number; @@ -3297,40 +2854,26 @@ export interface FileDownloadOptions extends CommonOptions { * When this header is set to true and * specified together with the Range header, the service returns the MD5 hash * for the range, as long as the range is less than or equal to 4 MB in size. - * - * @type {boolean} - * @memberof FileDownloadOptions */ rangeGetContentMD5?: boolean; /** * Download progress updating event handler. - * - * @memberof FileDownloadOptions */ onProgress?: (progress: TransferProgressEvent) => void; /** * Lease access conditions. - * - * @type {LeaseAccessConditions} - * @memberof FileDownloadOptions */ leaseAccessConditions?: LeaseAccessConditions; } /** * Options to configure the {@link ShareFileClient.uploadRange} operation. - * - * @export - * @interface FileUploadRangeOptions */ export interface FileUploadRangeOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileUploadRangeOptions */ abortSignal?: AbortSignalLike; /** @@ -3340,40 +2883,26 @@ export interface FileUploadRangeOptions extends CommonOptions { * content that has arrived with the header value that was sent. If the two * hashes do not match, the operation will fail with error code 400 (Bad * Request). - * - * @type {Uint8Array} - * @memberof FileUploadRangeOptions */ contentMD5?: Uint8Array; /** * Progress updating event handler. - * - * @memberof FileUploadRangeOptions */ onProgress?: (progress: TransferProgressEvent) => void; /** * Lease access conditions. - * - * @type {LeaseAccessConditions} - * @memberof FileUploadRangeOptions */ leaseAccessConditions?: LeaseAccessConditions; } /** * Options to configure the {@link ShareFileClient.uploadRangeFromURL} operation. - * - * @export - * @interface FileUploadRangeFromURLOptions */ export interface FileUploadRangeFromURLOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileUploadRangeFromURLOptions */ abortSignal?: AbortSignalLike; /** @@ -3392,9 +2921,6 @@ export interface FileUploadRangeFromURLOptions extends CommonOptions { sourceConditions?: SourceModifiedAccessConditions; /** * Lease access conditions. - * - * @type {LeaseAccessConditions} - * @memberof FileUploadRangeFromURLOptions */ leaseAccessConditions?: LeaseAccessConditions; } @@ -3424,72 +2950,45 @@ export interface FileUploadRangeFromURLOptions extends CommonOptions { /** * Options to configure the {@link ShareFileClient.getRangeList} operation. - * - * @export - * @interface FileGetRangeListOptions */ export interface FileGetRangeListOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileGetRangeListOptions */ abortSignal?: AbortSignalLike; /** * Optional. Specifies the range of bytes over which to list ranges, inclusively. - * - * @type {Range} - * @memberof FileGetRangeListOptions */ range?: Range; /** * Lease access conditions. - * - * @type {LeaseAccessConditions} - * @memberof FileGetRangeListOptions */ leaseAccessConditions?: LeaseAccessConditions; } /** * Options to configure the {@link ShareFileClient.exists} operation. - * - * @export - * @interface FileExistsOptions */ export interface FileExistsOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileExistsOptions */ abortSignal?: AbortSignalLike; } /** * Options to configure the {@link ShareFileClient.getProperties} operation. - * - * @export - * @interface FileGetPropertiesOptions */ export interface FileGetPropertiesOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileGetPropertiesOptions */ abortSignal?: AbortSignalLike; /** * Lease access conditions. - * - * @type {LeaseAccessConditions} - * @memberof FileGetPropertiesOptions */ leaseAccessConditions?: LeaseAccessConditions; } @@ -3500,8 +2999,6 @@ export interface FileGetPropertiesOptions extends CommonOptions { export type FileGetRangeListResponse = FileGetRangeListHeaders & { /** * Range list for an Azure file. - * - * @type {RangeModel[]} */ rangeList: RangeModel[]; @@ -3526,90 +3023,57 @@ export type FileGetRangeListResponse = FileGetRangeListHeaders & { /** * Options to configure the {@link ShareFileClient.startCopyFromURL} operation. - * - * @export - * @interface FileStartCopyOptions */ export interface FileStartCopyOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileStartCopyOptions */ abortSignal?: AbortSignalLike; /** * A collection of key-value string pair to associate with the file storage object. - * - * @type {Metadata} - * @memberof FileStartCopyOptions */ metadata?: Metadata; /** * Lease access conditions. - * - * @type {LeaseAccessConditions} - * @memberof FileStartCopyOptions */ leaseAccessConditions?: LeaseAccessConditions; /** * If specified the permission (security descriptor) shall be set for the directory/file. This - * header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be + * header can be used if Permission size is lesser than or equal to 8KB, else x-ms-file-permission-key header shall be * used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and * dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be * specified. - * - * @type {string} - * @memberof FileStartCopyOptions */ filePermission?: string; /** * Key of the permission to be set for the directory/file. Note: Only one of the * x-ms-file-permission or x-ms-file-permission-key should be specified. - * - * @type {string} - * @memberof FileStartCopyOptions */ filePermissionKey?: string; /** * SMB info. - * - * @type {CopyFileSmbInfo} - * @memberof FileStartCopyOptions */ copyFileSmbInfo?: CopyFileSmbInfo; } /** * Options to configure the {@link ShareFileClient.setMetadata} operation. - * - * @export - * @interface FileSetMetadataOptions */ export interface FileSetMetadataOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileSetMetadataOptions */ abortSignal?: AbortSignalLike; /** * Lease access conditions. - * - * @type {LeaseAccessConditions} - * @memberof FileSetMetadataOptions */ leaseAccessConditions?: LeaseAccessConditions; } /** * Options to configure the {@link ShareFileClient.setHttpHeaders} operation. - * - * @export - * @interface FileSetHttpHeadersOptions */ export interface FileSetHttpHeadersOptions extends FileAndDirectorySetPropertiesCommonOptions, @@ -3617,49 +3081,31 @@ export interface FileSetHttpHeadersOptions /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileSetHttpHeadersOptions */ abortSignal?: AbortSignalLike; /** * Lease access conditions. - * - * @type {LeaseAccessConditions} - * @memberof FileSetHttpHeadersOptions */ leaseAccessConditions?: LeaseAccessConditions; } /** * Options to configure the {@link ShareFileClient.abortCopyFromURL} operation. - * - * @export - * @interface FileAbortCopyFromURLOptions */ export interface FileAbortCopyFromURLOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileAbortCopyFromURLOptions */ abortSignal?: AbortSignalLike; /** * Lease access conditions. - * - * @type {LeaseAccessConditions} - * @memberof FileAbortCopyFromURLOptions */ leaseAccessConditions?: LeaseAccessConditions; } /** * Options to configure the {@link ShareFileClient.resize} operation. - * - * @export - * @interface FileResizeOptions */ export interface FileResizeOptions extends FileAndDirectorySetPropertiesCommonOptions, @@ -3667,40 +3113,25 @@ export interface FileResizeOptions /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileResizeOptions */ abortSignal?: AbortSignalLike; /** * Lease access conditions. - * - * @type {LeaseAccessConditions} - * @memberof FileResizeOptions */ leaseAccessConditions?: LeaseAccessConditions; } /** * Options to configure the {@link ShareFileClient.clearRange} operation. - * - * @export - * @interface FileClearRangeOptions */ export interface FileClearRangeOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileClearRangeOptions */ abortSignal?: AbortSignalLike; /** * Lease access conditions. - * - * @type {LeaseAccessConditions} - * @memberof FileClearRangeOptions */ leaseAccessConditions?: LeaseAccessConditions; } @@ -3712,25 +3143,16 @@ export interface FileClearRangeOptions extends CommonOptions { * - {@link ShareFileClient.listHandlesSegment} * - {@link ShareFileClient.iterateHandleSegments} * - {@link ShareFileClient.listHandleItems} - * - * @export - * @interface FileListHandlesSegmentOptions */ export interface FileListHandlesSegmentOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileClearRangeOptions */ abortSignal?: AbortSignalLike; /** * Specifies the maximum number of entries to return. If the request does not specify maxResults, * or specifies a value greater than 5,000, the server will return up to 5,000 items. - * - * @type {number} - * @memberof FileListHandlesSegmentOptions */ maxPageSize?: number; } @@ -3739,9 +3161,6 @@ export interface FileListHandlesOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileClearRangeOptions */ abortSignal?: AbortSignalLike; } @@ -3753,17 +3172,11 @@ export interface FileListHandlesOptions extends CommonOptions { * - {@link ShareFileClient.forceCloseHandlesSegment} * - {@link ShareFileClient.forceCloseAllHandles} * - {@link ShareFileClient.forceCloseHandle} - * - * @export - * @interface FileForceCloseHandlesOptions */ export interface FileForceCloseHandlesOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileForceCloseHandlesOptions */ abortSignal?: AbortSignalLike; } @@ -3811,46 +3224,29 @@ export type FileForceCloseHandlesResponse = CloseHandlesInfo & /** * Option interface for ShareFileClient.uploadStream(). - * - * @export - * @interface FileUploadStreamOptions */ export interface FileUploadStreamOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileUploadStreamOptions */ abortSignal?: AbortSignalLike; /** * Azure File HTTP Headers. - * - * @type {FileHttpHeaders} - * @memberof FileUploadStreamOptions */ fileHttpHeaders?: FileHttpHeaders; /** * Metadata of the Azure file. - * - * @type {Metadata} - * @memberof FileUploadStreamOptions */ metadata?: Metadata; /** * Progress updater. - * - * @memberof FileUploadStreamOptions */ onProgress?: (progress: TransferProgressEvent) => void; /** * Lease access conditions. - * - * @type {LeaseAccessConditions} - * @memberof FileUploadStreamOptions */ leaseAccessConditions?: LeaseAccessConditions; } @@ -3861,91 +3257,59 @@ export interface FileUploadStreamOptions extends CommonOptions { * See: * - {@link ShareFileClient.uploadFile} * - {@link ShareFileClient.uploadSeekableStream} - * - * @export - * @interface FileParallelUploadOptions */ export interface FileParallelUploadOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileParallelUploadOptions */ abortSignal?: AbortSignalLike; /** * RangeSize specifies the range size to use in each parallel upload, * the default (and maximum size) is FILE_RANGE_MAX_SIZE_BYTES. - * - * @type {number} - * @memberof FileParallelUploadOptions */ rangeSize?: number; /** * Progress updater. - * - * @memberof FileParallelUploadOptions */ onProgress?: (progress: TransferProgressEvent) => void; /** * File HTTP Headers. - * - * @type {FileHttpHeaders} - * @memberof FileParallelUploadOptions */ fileHttpHeaders?: FileHttpHeaders; /** * Metadata of an Azure file. - * - * @type {Metadata} - * @memberof FileParallelUploadOptions */ metadata?: Metadata; /** * Concurrency indicates the maximum number of ranges to upload in parallel. * If not provided, 5 concurrency will be used by default. - * - * @type {number} - * @memberof FileParallelUploadOptions */ concurrency?: number; /** * Lease access conditions. - * - * @type {LeaseAccessConditions} - * @memberof FileParallelUploadOptions */ leaseAccessConditions?: LeaseAccessConditions; } /** * Option interface for the {@link ShareFileClient.downloadToBuffer} operation. - * - * @export - * @interface FileDownloadToBufferOptions */ export interface FileDownloadToBufferOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof FileDownloadToBufferOptions */ abortSignal?: AbortSignalLike; /** * When downloading Azure files, download method will try to split large file into small ranges. * Every small range will be downloaded via a separate request. * This option defines size data every small request trying to download. - * Must be > 0, will use the default value if undefined, - * - * @type {number} - * @memberof FileDownloadToBufferOptions + * Must be greater than 0, will use the default value if undefined, */ rangeSize?: number; @@ -3961,81 +3325,51 @@ export interface FileDownloadToBufferOptions extends CommonOptions { * maxRetryRequestsPerRange is reached. * * Default value is 5, please set a larger value when in poor network. - * - * @type {number} - * @memberof FileDownloadToBufferOptions */ maxRetryRequestsPerRange?: number; /** * Progress updater. - * - * @memberof FileDownloadToBufferOptions */ onProgress?: (progress: TransferProgressEvent) => void; /** * Concurrency indicates the maximum number of ranges to download in parallel. * If not provided, 5 concurrency will be used by default. - * - * @type {number} - * @memberof FileDownloadToBufferOptions */ concurrency?: number; /** * Lease access conditions. - * - * @type {LeaseAccessConditions} - * @memberof FileDownloadToBufferOptions */ leaseAccessConditions?: LeaseAccessConditions; } /** * Contains response data for the {@link ShareFileClient.deleteIfExists} operation. - * - * @export - * @interface FileDeleteIfExistsResponse */ export interface FileDeleteIfExistsResponse extends FileDeleteResponse { /** * Indicate whether the file is successfully deleted. Is false if the file does not exist in the first place. - * - * @type {boolean} - * @memberof FileDeleteIfExistsResponse */ succeeded: boolean; } /** * Options to configure {@link ShareFileClient.generateSasUrl} operation. - * - * @export - * @interface FileGenerateSasUrlOptions */ export interface FileGenerateSasUrlOptions extends CommonGenerateSasUrlOptions { /** * Optional only when identifier is provided. Specifies the list of permissions to be associated with the SAS. - * - * @type {FileSASPermissions} - * @memberof FileGenerateSasUrlOptions */ permissions?: FileSASPermissions; } /** * A ShareFileClient represents a URL to an Azure Storage file. - * - * @export - * @class ShareFileClient */ export class ShareFileClient extends StorageClient { /** * context provided by protocol layer. - * - * @private - * @type {File} - * @memberof ShareFileClient */ private context: File; @@ -4045,9 +3379,6 @@ export class ShareFileClient extends StorageClient { /** * The share name corresponding to this file client - * - * @type {string} - * @memberof ShareFileClient */ public get shareName(): string { return this._shareName; @@ -4055,9 +3386,6 @@ export class ShareFileClient extends StorageClient { /** * The full path of the file - * - * @type {string} - * @memberof ShareFileClient */ public get path(): string { return this._path; @@ -4065,9 +3393,6 @@ export class ShareFileClient extends StorageClient { /** * The name of the file - * - * @type {string} - * @memberof ShareFileClient */ public get name(): string { return this._name; @@ -4087,7 +3412,6 @@ export class ShareFileClient extends StorageClient { * @param credential - Such as AnonymousCredential or StorageSharedKeyCredential. * If not specified, AnonymousCredential is used. * @param options - Optional. Options to configure the HTTP pipeline. - * @memberof ShareFileClient */ constructor(url: string, credential?: Credential, options?: StoragePipelineOptions); /** @@ -4103,7 +3427,6 @@ export class ShareFileClient extends StorageClient { * Such as a file named "myfile%", the URL should be "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25". * @param pipeline - Call newPipeline() to create a default * pipeline, or provide a customized pipeline. - * @memberof ShareFileClient */ constructor(url: string, pipeline: Pipeline); constructor( @@ -4136,7 +3459,6 @@ export class ShareFileClient extends StorageClient { * * @param shareSnapshot - The share snapshot timestamp. * @returns A new ShareFileClient object identical to the source but with the specified share snapshot timestamp. - * @memberof ShareFileClient */ public withShareSnapshot(shareSnapshot: string): ShareFileClient { return new ShareFileClient( @@ -4156,7 +3478,6 @@ export class ShareFileClient extends StorageClient { * @param size - Specifies the maximum size in bytes for the file, up to 4 TB. * @param options - Options to File Create operation. * @returns Response data for the File Create operation. - * @memberof ShareFileClient * * Example usage: * @@ -4223,11 +3544,10 @@ export class ShareFileClient extends StorageClient { * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-file * - * @param offset - From which position of the file to download, >= 0 - * @param count - How much data to be downloaded, > 0. Will download to the end when undefined + * @param offset - From which position of the file to download, greater than or equal to 0 + * @param count - How much data to be downloaded, greater than 0. Will download to the end when undefined * @param options - Options to File Download operation. * @returns Response data for the File Download operation. - * @memberof ShareFileClient * * Example usage (Node.js): * @@ -4370,8 +3690,6 @@ export class ShareFileClient extends StorageClient { * function completes. * * @param options - options to Exists operation. - * - * @memberof ShareFileClient */ public async exists(options: FileExistsOptions = {}): Promise { const { span, spanOptions } = createSpan("ShareFileClient-exists", options.tracingOptions); @@ -4409,7 +3727,6 @@ export class ShareFileClient extends StorageClient { * * @param options - Options to File Get Properties operation. * @returns Response data for the File Get Properties operation. - * @memberof ShareFileClient */ public async getProperties( options: FileGetPropertiesOptions = {} @@ -4443,8 +3760,6 @@ export class ShareFileClient extends StorageClient { * if no values are provided, existing HTTP headers will be removed. * For other file properties(e.g. fileAttributes), if no values are provided, * existing values will be preserved. - * - * @memberof ShareFileClient */ public async setProperties(properties: FileProperties = {}): Promise { const { span, spanOptions } = createSpan( @@ -4496,7 +3811,6 @@ export class ShareFileClient extends StorageClient { * * @param options - Options to File Delete operation. * @returns Response data for the File Delete operation. - * @memberof ShareFileClient */ public async delete(options: FileDeleteOptions = {}): Promise { const { span, spanOptions } = createSpan("ShareFileClient-delete", options.tracingOptions); @@ -4532,8 +3846,6 @@ export class ShareFileClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2 * * @param options - - * - * @memberof ShareFileClient */ public async deleteIfExists( options: FileDeleteOptions = {} @@ -4587,7 +3899,6 @@ export class ShareFileClient extends StorageClient { * Provide undefined will remove existing HTTP headers. * @param options - Options to File Set HTTP Headers operation. * @returns Response data for the File Set HTTP Headers operation. - * @memberof ShareFileClient */ public async setHttpHeaders( fileHttpHeaders: FileHttpHeaders = {}, @@ -4634,7 +3945,6 @@ export class ShareFileClient extends StorageClient { * then all ranges above the specified byte value are cleared. * @param options - Options to File Resize operation. * @returns Response data for the File Set HTTP Headers operation. - * @memberof ShareFileClient */ public async resize( length: number, @@ -4682,7 +3992,6 @@ export class ShareFileClient extends StorageClient { * @param metadata - If no metadata provided, all existing directory metadata will be removed * @param options - Options to File Set Metadata operation. * @returns Response data for the File Set Metadata operation. - * @memberof ShareFileClient */ public async setMetadata( metadata: Metadata = {}, @@ -4719,7 +4028,6 @@ export class ShareFileClient extends StorageClient { * string including non non-Base64/Hex-encoded characters. * @param options - Options to File Upload Range operation. * @returns Response data for the File Upload Range operation. - * @memberof ShareFileClient * * Example usage: * @@ -4788,8 +4096,6 @@ export class ShareFileClient extends StorageClient { * @param destOffset - Offset of destination file. * @param count - Number of bytes to be uploaded from source file. * @param options - Options to configure File - Upload Range from URL operation. - * - * @memberof FileURL */ public async uploadRangeFromURL( sourceURL: string, @@ -4840,8 +4146,6 @@ export class ShareFileClient extends StorageClient { * @param offset - * @param contentLength - * @param options - Options to File Clear Range operation. - * - * @memberof ShareFileClient */ public async clearRange( offset: number, @@ -4879,8 +4183,6 @@ export class ShareFileClient extends StorageClient { * Returns the list of valid ranges for a file. * * @param options - Options to File Get range List operation. - * - * @memberof ShareFileClient */ public async getRangeList( options: FileGetRangeListOptions = {} @@ -4922,8 +4224,6 @@ export class ShareFileClient extends StorageClient { * * @param prevShareSnapshot - The previous snapshot parameter is an opaque DateTime value that specifies the previous share snapshot to compare with. * @param options - - * - * @memberof ShareFileClient */ public async getRangeListDiff( prevShareSnapshot: string, @@ -4962,8 +4262,6 @@ export class ShareFileClient extends StorageClient { * blob, no authentication is required to perform the copy operation. A file in a share snapshot * can also be specified as a copy source. * @param options - Options to File Start Copy operation. - * - * @memberof ShareFileClient */ public async startCopyFromURL( copySource: string, @@ -5001,8 +4299,6 @@ export class ShareFileClient extends StorageClient { * * @param copyId - Id of the Copy File operation to abort. * @param options - Options to File Abort Copy From URL operation. - * - * @memberof ShareFileClient */ public async abortCopyFromURL( copyId: string, @@ -5036,7 +4332,6 @@ export class ShareFileClient extends StorageClient { * * @param data - Buffer(Node), Blob, ArrayBuffer or ArrayBufferView * @param options - - * */ public async uploadData( data: Buffer | Blob | ArrayBuffer | ArrayBufferView, @@ -5091,7 +4386,6 @@ export class ShareFileClient extends StorageClient { * @param blobFactory - * @param size - * @param options - - * */ async uploadSeekableBlob( blobFactory: (offset: number, size: number) => Blob, @@ -5126,7 +4420,6 @@ export class ShareFileClient extends StorageClient { * @param filePath - Full path of local file * @param fileClient - ShareFileClient * @param options - - * */ public async uploadFile( filePath: string, @@ -5165,13 +4458,11 @@ export class ShareFileClient extends StorageClient { * The Readable stream factory must returns a Node.js Readable stream starting from the offset defined. The offset * is the offset in the Azure file to be uploaded. * - * @export * @param streamFactory - Returns a Node.js Readable stream starting * from the offset defined * @param size - Size of the Azure file * @param fileClient - ShareFileClient * @param options - - * */ async uploadResetableStream( streamFactory: (offset: number, count?: number) => NodeJS.ReadableStream, @@ -5207,7 +4498,6 @@ export class ShareFileClient extends StorageClient { * @param size - Size of the Azure file * @param fileClient - ShareFileClient * @param options - - * */ private async uploadSeekableInternal( bodyFactory: (offset: number, count: number) => HttpRequestBody, @@ -5295,7 +4585,6 @@ export class ShareFileClient extends StorageClient { * @param offset - From which position of the Azure File to download * @param count - How much data to be downloaded. Will download to the end when passing undefined * @param options - - * */ public async downloadToBuffer( buffer: Buffer, @@ -5317,7 +4606,6 @@ export class ShareFileClient extends StorageClient { * @param offset - From which position of the Azure file to download * @param count - How much data to be downloaded. Will download to the end when passing undefined * @param options - - * */ public async downloadToBuffer( offset?: number, @@ -5462,11 +4750,10 @@ export class ShareFileClient extends StorageClient { * @param size - Size of file to be created. Maximum size allowed is 4 TB. * If this value is larger than stream size, there will be empty bytes in file tail. * @param bufferSize - Size of every buffer allocated in bytes, also the chunk/range size during - * the uploaded file. Size must be > 0 and <= 4 * 1024 * 1024 (4MB) + * the uploaded file. Size must be greater than 0 and lesser than or equal to 4 * 1024 * 1024 (4MB) * @param maxBuffers - Max buffers will allocate during uploading, positive correlation * with max uploading concurrency * @param options - - * */ public async uploadStream( stream: Readable, @@ -5559,7 +4846,6 @@ export class ShareFileClient extends StorageClient { * but with readableStreamBody set to undefined since its * content is already read and written into a local file * at the specified path. - * @memberof BlobClient */ public async downloadToFile( filePath: string, @@ -5604,8 +4890,6 @@ export class ShareFileClient extends StorageClient { * The marker value may then be used in a subsequent call to request the next * set of list items. * @param options - - * - * @memberof FileURL */ private async listHandlesSegment( marker?: string, @@ -5644,15 +4928,12 @@ export class ShareFileClient extends StorageClient { /** * Returns an AsyncIterableIterator for FileListHandlesResponse * - * @private * @param marker - A string value that identifies the portion of the list to be * returned with the next list handles operation. The operation returns a * marker value within the response body if the list returned was not complete. * The marker value may then be used in a subsequent call to request the next * set of list items. * @param options - Options to list handles operation. - * - * @memberof ShareFileClient */ private async *iterateHandleSegments( marker?: string, @@ -5671,10 +4952,7 @@ export class ShareFileClient extends StorageClient { /** * Returns an AsyncIterableIterator for handles * - * @private * @param options - Options to list handles operation. - * - * @memberof ShareFileClient */ private async *listHandleItems( options: FileListHandlesSegmentOptions = {} @@ -5696,7 +4974,6 @@ export class ShareFileClient extends StorageClient { * .byPage() returns an async iterable iterator to list the handles in pages. * * @param options - Options to list handles operation. - * @memberof ShareFileClient * * An asyncIterableIterator that supports paging. */ @@ -5707,19 +4984,19 @@ export class ShareFileClient extends StorageClient { const iter = this.listHandleItems(options); return { /** - * @member {Promise} [next] The next method, part of the iteration protocol + * The next method, part of the iteration protocol */ async next() { return iter.next(); }, /** - * @member {Symbol} [asyncIterator] The connection to the async iterator, part of the iteration protocol + * The connection to the async iterator, part of the iteration protocol */ [Symbol.asyncIterator]() { return this; }, /** - * @member {Function} [byPage] Return an AsyncIterableIterator that works a page at a time + * Return an AsyncIterableIterator that works a page at a time */ byPage: (settings: PageSettings = {}) => { return this.iterateHandleSegments(settings.continuationToken, { @@ -5740,8 +5017,6 @@ export class ShareFileClient extends StorageClient { * body if there are more handles to close. The marker value * may then be used in a subsequent call to close the next set of handles. * @param options - Options to force close handles operation. - * - * @memberof ShareFileClient */ private async forceCloseHandlesSegment( marker?: string, @@ -5778,8 +5053,6 @@ export class ShareFileClient extends StorageClient { * @see https://docs.microsoft.com/en-us/rest/api/storageservices/force-close-handles * * @param options - Options to force close handles operation. - * - * @memberof ShareFileClient */ public async forceCloseAllHandles( options: FileForceCloseHandlesOptions = {} @@ -5824,9 +5097,7 @@ export class ShareFileClient extends StorageClient { * * @param handleId - Specific handle ID, cannot be asterisk "*". * Use forceCloseAllHandles() to close all handles. - * @param FileForceCloseHandlesOptions} [options] Options to force close handles operation. - * - * @memberof ShareFileClient + * @param FileForceCloseHandlesOptions - Options to force close handles operation. */ public async forceCloseHandle( handleId: string, @@ -5867,7 +5138,6 @@ export class ShareFileClient extends StorageClient { * * @param proposeLeaseId - Initial proposed lease Id. * @returns A new ShareLeaseClient object for managing leases on the file. - * @memberof ShareFileClient */ public getShareLeaseClient(proposeLeaseId?: string) { return new ShareLeaseClient(this, proposeLeaseId); @@ -5883,7 +5153,6 @@ export class ShareFileClient extends StorageClient { * * @param options - Optional parameters. * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token. - * @memberof ShareFileClient */ public generateSasUrl(options: FileGenerateSasUrlOptions): string { if (!(this.credential instanceof StorageSharedKeyCredential)) { @@ -5965,17 +5234,11 @@ export type LeaseOperationResponse = LeaseOperationResponseHeaders & { /** * lease operations options. - * - * @export - * @interface LeaseOperationOptions */ export interface LeaseOperationOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof LeaseOperationOptions */ abortSignal?: AbortSignalLike; } @@ -5985,9 +5248,6 @@ export interface LeaseOperationOptions extends CommonOptions { * @see https://docs.microsoft.com/rest/api/storageservices/lease-file * and * @see https://docs.microsoft.com/rest/api/storageservices/lease-share - * - * @export - * @class ShareLeaseClient */ export class ShareLeaseClient { private _leaseId: string; @@ -5998,8 +5258,6 @@ export class ShareLeaseClient { * Gets the lease Id. * * @readonly - * @memberof ShareLeaseClient - * @type {string} */ public get leaseId(): string { return this._leaseId; @@ -6009,8 +5267,6 @@ export class ShareLeaseClient { * Gets the url. * * @readonly - * @memberof ShareLeaseClient - * @type {string} */ public get url(): string { return this._url; @@ -6020,7 +5276,6 @@ export class ShareLeaseClient { * Creates an instance of ShareLeaseClient. * @param client - The client to make the lease operation requests. * @param leaseId - Initial proposed lease id. - * @memberof ShareLeaseClient */ constructor(client: ShareFileClient, leaseId?: string) { const clientContext = new StorageClientContext( @@ -6050,7 +5305,6 @@ export class ShareLeaseClient { * @param duration - Specifies the duration of lease in seconds. For file, the only allowed value is -1 for a lease that never expires. For share, must be -1 or between 15 to 60. * @param options - Options for the lease management operation. * @returns Response data for acquire lease operation. - * @memberof ShareLeaseClient */ public async acquireLease( duration: number = -1, @@ -6084,7 +5338,6 @@ export class ShareLeaseClient { * @param proposedLeaseId - the proposed new lease Id. * @param options - Options for the lease management operation. * @returns Response data for change lease operation. - * @memberof ShareLeaseClient */ public async changeLease( proposedLeaseId: string, @@ -6119,7 +5372,6 @@ export class ShareLeaseClient { * * @param options - Options for the lease management operation. * @returns Response data for release lease operation. - * @memberof ShareLeaseClient */ public async releaseLease(options: LeaseOperationOptions = {}): Promise { const { span, spanOptions } = createSpan( @@ -6147,7 +5399,6 @@ export class ShareLeaseClient { * * @param options - Options for the lease management operation. * @returns Response data for break lease operation. - * @memberof ShareLeaseClient */ public async breakLease(options: LeaseOperationOptions = {}): Promise { const { span, spanOptions } = createSpan("ShareLeaseClient-breakLease", options.tracingOptions); @@ -6174,7 +5425,6 @@ export class ShareLeaseClient { * * @param options - Options for the lease management operation. * @returns Response data for renew lease operation. - * @memberof ShareLeaseClient */ public async renewLease(options: LeaseOperationOptions = {}): Promise { const { span, spanOptions } = createSpan("ShareLeaseClient-renewLease", options.tracingOptions); diff --git a/sdk/storage/storage-file-share/src/FileDownloadResponse.ts b/sdk/storage/storage-file-share/src/FileDownloadResponse.ts index 15af32263fdd..05924fbeb491 100644 --- a/sdk/storage/storage-file-share/src/FileDownloadResponse.ts +++ b/sdk/storage/storage-file-share/src/FileDownloadResponse.ts @@ -26,10 +26,6 @@ import { * * The {@link readableStreamBody} stream will retry beneath the `ReadableStream` layer, so you can just use it as * a normal Node.js Readable stream. - * - * @export - * @class FileDownloadResponse - * @implements {FileDownloadResponseModel} */ export class FileDownloadResponse implements FileDownloadResponseModel { /** @@ -37,8 +33,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * requests for partial file content. * * @readonly - * @type {(string | undefined)} - * @memberof FileDownloadResponse */ public get acceptRanges(): string | undefined { return this.originalResponse.acceptRanges; @@ -49,8 +43,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * for the file. * * @readonly - * @type {(string | undefined)} - * @memberof FileDownloadResponse */ public get cacheControl(): string | undefined { return this.originalResponse.cacheControl; @@ -62,8 +54,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * response. * * @readonly - * @type {(string | undefined)} - * @memberof FileDownloadResponse */ public get contentDisposition(): string | undefined { return this.originalResponse.contentDisposition; @@ -74,8 +64,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * for the Content-Encoding request header. * * @readonly - * @type {(string | undefined)} - * @memberof FileDownloadResponse */ public get contentEncoding(): string | undefined { return this.originalResponse.contentEncoding; @@ -86,8 +74,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * for the Content-Language request header. * * @readonly - * @type {(string | undefined)} - * @memberof FileDownloadResponse */ public get contentLanguage(): string | undefined { return this.originalResponse.contentLanguage; @@ -98,8 +84,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * response body. * * @readonly - * @type {(number | undefined)} - * @memberof FileDownloadResponse */ public get contentLength(): number | undefined { return this.originalResponse.contentLength; @@ -116,8 +100,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * header. * * @readonly - * @type {(Uint8Array | undefined)} - * @memberof FileDownloadResponse */ public get contentMD5(): Uint8Array | undefined { return this.originalResponse.contentMD5; @@ -129,8 +111,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * header. * * @readonly - * @type {(string | undefined)} - * @memberof FileDownloadResponse */ public get contentRange(): string | undefined { return this.originalResponse.contentRange; @@ -141,8 +121,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * The default content type is 'application/octet-stream' * * @readonly - * @type {(string | undefined)} - * @memberof FileDownloadResponse */ public get contentType(): string | undefined { return this.originalResponse.contentType; @@ -154,8 +132,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * can specify the time of a completed, aborted, or failed copy attempt. * * @readonly - * @type {(Date | undefined)} - * @memberof FileDownloadResponse */ public get copyCompletedOn(): Date | undefined { return this.originalResponse.copyCompletedOn; @@ -166,8 +142,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * File operation where this file was the destination file. * * @readonly - * @type {(string | undefined)} - * @memberof FileDownloadResponse */ public get copyId(): string | undefined { return this.originalResponse.copyId; @@ -180,8 +154,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * Content-Length bytes copied. * * @readonly - * @type {(string | undefined)} - * @memberof FileDownloadResponse */ public get copyProgress(): string | undefined { return this.originalResponse.copyProgress; @@ -193,8 +165,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * was the destination file. * * @readonly - * @type {(string | undefined)} - * @memberof FileDownloadResponse */ public get copySource(): string | undefined { return this.originalResponse.copySource; @@ -206,8 +176,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * 'success', 'aborted', 'failed' * * @readonly - * @type {(CopyStatusType | undefined)} - * @memberof FileDownloadResponse */ public get copyStatus(): CopyStatusType | undefined { return this.originalResponse.copyStatus; @@ -219,8 +187,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * non-fatal copy operation failure. * * @readonly - * @type {(string | undefined)} - * @memberof FileDownloadResponse */ public get copyStatusDescription(): string | undefined { return this.originalResponse.copyStatusDescription; @@ -231,8 +197,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * indicates the time at which the response was initiated. * * @readonly - * @type {(Date | undefined)} - * @memberof FileDownloadResponse */ public get date(): Date | undefined { return this.originalResponse.date; @@ -243,8 +207,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * perform operations conditionally, in quotes. * * @readonly - * @type {(string | undefined)} - * @memberof FileDownloadResponse */ public get etag(): string | undefined { return this.originalResponse.etag; @@ -262,8 +224,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * latter calculated from the requested range. * * @readonly - * @type {(Uint8Array | undefined)} - * @memberof FileDownloadResponse */ public get fileContentMD5(): Uint8Array | undefined { return this.originalResponse.fileContentMD5; @@ -277,8 +237,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * are encrypted). * * @readonly - * @type {(boolean | undefined)} - * @memberof FileDownloadResponse */ public get isServerEncrypted(): boolean | undefined { return this.originalResponse.isServerEncrypted; @@ -290,8 +248,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * the last modified time. * * @readonly - * @type {(Date | undefined)} - * @memberof FileDownloadResponse */ public get lastModified(): Date | undefined { return this.originalResponse.lastModified; @@ -302,8 +258,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * to associate with a file storage object. * * @readonly - * @type {(Metadata | undefined)} - * @memberof FileDownloadResponse */ public get metadata(): Metadata | undefined { return this.originalResponse.metadata; @@ -314,8 +268,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * that was made and can be used for troubleshooting the request. * * @readonly - * @type {(string | undefined)} - * @memberof FileDownloadResponse */ public get requestId(): string | undefined { return this.originalResponse.requestId; @@ -326,8 +278,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * to execute the request. * * @readonly - * @type {(string | undefined)} - * @memberof FileDownloadResponse */ public get version(): string | undefined { return this.originalResponse.version; @@ -337,8 +287,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * Attributes set for the file. * * @readonly - * @type {(string | undefined)} - * @memberof FileDownloadResponse */ public get fileAttributes(): string | undefined { return this.originalResponse.fileAttributes; @@ -348,8 +296,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * Creation time for the file. * * @readonly - * @type {(Date | undefined)} - * @memberof FileDownloadResponse */ public get fileCreatedOn(): Date | undefined { return this.originalResponse.fileCreatedOn; @@ -359,8 +305,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * Last write time for the file. * * @readonly - * @type {(string | undefined)} - * @memberof FileDownloadResponse */ public get fileLastWriteOn(): Date | undefined { return this.originalResponse.fileLastWriteOn; @@ -370,8 +314,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * Change time for the file. * * @readonly - * @type {(string | undefined)} - * @memberof FileDownloadResponse */ public get fileChangeOn(): Date | undefined { return this.originalResponse.fileChangeOn; @@ -381,8 +323,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * Key of the permission set for the file. * * @readonly - * @type {(string | undefined)} - * @memberof FileDownloadResponse */ public get filePermissionKey(): string | undefined { return this.originalResponse.filePermissionKey; @@ -392,8 +332,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * The fileId of the file. * * @readonly - * @type {(string | undefined)} - * @memberof FileDownloadResponse */ public get fileId(): string | undefined { return this.originalResponse.fileId; @@ -403,8 +341,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * The parent fileId of the file. * * @readonly - * @type {(string | undefined)} - * @memberof FileDownloadResponse */ public get fileParentId(): string | undefined { return this.originalResponse.fileParentId; @@ -415,8 +351,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * Always undefined in node.js. * * @readonly - * @type {(Promise | undefined)} - * @memberof FileDownloadResponse */ public get contentAsBlob(): Promise | undefined { return this.originalResponse.blobBody; @@ -452,8 +386,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * It will automatically retry when internal read stream unexpected ends. * * @readonly - * @type {(NodeJS.ReadableStream | undefined)} - * @memberof FileDownloadResponse */ public get readableStreamBody(): NodeJS.ReadableStream | undefined { return isNode ? this.fileDownloadStream : undefined; @@ -476,7 +408,6 @@ export class FileDownloadResponse implements FileDownloadResponseModel { * @param offset - * @param count - * @param options - - * @memberof FileDownloadResponse */ public constructor( originalResponse: FileDownloadResponseModel, diff --git a/sdk/storage/storage-file-share/src/FileSASPermissions.ts b/sdk/storage/storage-file-share/src/FileSASPermissions.ts index 8014eaba1a05..4afaa948babc 100644 --- a/sdk/storage/storage-file-share/src/FileSASPermissions.ts +++ b/sdk/storage/storage-file-share/src/FileSASPermissions.ts @@ -9,19 +9,13 @@ * the values are set, this should be serialized with toString and set as the permissions field on a * {@link FileSASSignatureValues} 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 - * @class FileSASPermissions */ export class FileSASPermissions { /** * Creates a FileSASPermissions from the specified permissions string. This method will throw an * Error if it encounters a character that does not correspond to a valid permission. * - * @static * @param permissions - - * - * @memberof FileSASPermissions */ public static parse(permissions: string): FileSASPermissions { const fileSASPermissions = new FileSASPermissions(); @@ -50,33 +44,21 @@ export class FileSASPermissions { /** * Specifies Read access granted. - * - * @type {boolean} - * @memberof FileSASPermissions */ public read: boolean = false; /** * Specifies Create access granted. - * - * @type {boolean} - * @memberof FileSASPermissions */ public create: boolean = false; /** * Specifies Write access granted. - * - * @type {boolean} - * @memberof FileSASPermissions */ public write: boolean = false; /** * Specifies Delete access granted. - * - * @type {boolean} - * @memberof FileSASPermissions */ public delete: boolean = false; @@ -85,7 +67,6 @@ export class FileSASPermissions { * order accepted by the service. * * @returns A string which represents the FileSASPermissions - * @memberof FileSASPermissions */ public toString(): string { const permissions: string[] = []; diff --git a/sdk/storage/storage-file-share/src/FileSASSignatureValues.ts b/sdk/storage/storage-file-share/src/FileSASSignatureValues.ts index 084916a2ddd5..13916f81e64e 100644 --- a/sdk/storage/storage-file-share/src/FileSASSignatureValues.ts +++ b/sdk/storage/storage-file-share/src/FileSASSignatureValues.ts @@ -13,42 +13,27 @@ import { truncatedISO8061Date } from "./utils/utils.common"; * ONLY AVAILABLE IN NODE.JS RUNTIME. * * FileSASSignatureValues is used to help generating File service SAS tokens for shares or files. - * - * @export - * @class FileSASSignatureValues */ export interface FileSASSignatureValues { /** * 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 FileSASSignatureValues */ version?: string; /** * Optional. SAS protocols, HTTPS only or HTTPSandHTTP - * - * @type {SASProtocol} - * @memberof FileSASSignatureValues */ protocol?: SASProtocol; /** * Optional. When the SAS will take effect. - * - * @type {Date} - * @memberof FileSASSignatureValues */ startsOn?: Date; /** * Optional only when identifier is provided. The time after which the SAS will no longer work. - * - * @type {Date} - * @memberof FileSASSignatureValues */ expiresOn?: Date; @@ -56,33 +41,21 @@ export interface FileSASSignatureValues { * Optional only when identifier is provided. * Please refer to either {@link ShareSASPermissions} or {@link FileSASPermissions} depending on the resource * being accessed for help constructing the permissions string. - * - * @type {FileSASPermissions | ShareSASPermissions} - * @memberof FileSASSignatureValues */ permissions?: FileSASPermissions | ShareSASPermissions; /** * Optional. IP ranges allowed in this SAS. - * - * @type {SasIPRange} - * @memberof FileSASSignatureValues */ ipRange?: SasIPRange; /** * The name of the share the SAS user may access. - * - * @type {string} - * @memberof FileSASSignatureValues */ shareName: string; /** * Optional. The path of the file like, "directory/FileName" or "FileName". - * - * @type {string} - * @memberof FileSASSignatureValues */ filePath?: string; @@ -90,49 +63,31 @@ export interface FileSASSignatureValues { * Optional. The name of the access policy on the share this SAS references if any. * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy - * - * @type {string} - * @memberof FileSASSignatureValues */ identifier?: string; /** * Optional. The cache-control header for the SAS. - * - * @type {string} - * @memberof FileSASSignatureValues */ cacheControl?: string; /** * Optional. The content-disposition header for the SAS. - * - * @type {string} - * @memberof FileSASSignatureValues */ contentDisposition?: string; /** * Optional. The content-encoding header for the SAS. - * - * @type {string} - * @memberof FileSASSignatureValues */ contentEncoding?: string; /** * Optional. The content-language header for the SAS. - * - * @type {string} - * @memberof FileSASSignatureValues */ contentLanguage?: string; /** * Optional. The content-type header for the SAS. - * - * @type {string} - * @memberof FileSASSignatureValues */ contentType?: string; } @@ -149,10 +104,8 @@ export interface FileSASSignatureValues { * You MUST assign value to identifier or expiresOn & permissions manually if you initial with * this constructor. * - * @export * @param fileSASSignatureValues - * @param sharedKeyCredential - - * */ export function generateFileSASQueryParameters( fileSASSignatureValues: FileSASSignatureValues, diff --git a/sdk/storage/storage-file-share/src/FileSystemAttributes.ts b/sdk/storage/storage-file-share/src/FileSystemAttributes.ts index 73e1c1931452..facdfdf007d4 100644 --- a/sdk/storage/storage-file-share/src/FileSystemAttributes.ts +++ b/sdk/storage/storage-file-share/src/FileSystemAttributes.ts @@ -4,19 +4,13 @@ /** * This is a helper class to construct a string representing the NTFS attributes to a file or directory. * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-file#file-system-attributes - * - * @export - * @class FileSystemAttributes */ export class FileSystemAttributes { /** * Creates a FileSystemAttributes from the specified attributes string. This method will throw an * Error if it encounters a string that does not correspond to a valid attributes. * - * @static * @param fileAttributes - The value of header x-ms-file-attributes. - * - * @memberof FileSystemAttributes */ public static parse(fileAttributes: string): FileSystemAttributes { if (!fileAttributes) { @@ -70,49 +64,31 @@ export class FileSystemAttributes { /** * Specifies a directory or file that is read-only. - * - * @type {boolean} - * @memberof FileSystemAttributes */ public readonly: boolean = false; /** * Specifies a directory or file is hidden. - * - * @type {boolean} - * @memberof FileSystemAttributes */ public hidden: boolean = false; /** * Specifies a directory or file that the operating system uses a part of, or uses exclusively. - * - * @type {boolean} - * @memberof FileSystemAttributes */ public system: boolean = false; /** * Specifies a directory or file that does not have other attributes set. This attribute is valid only when used alone. - * - * @type {boolean} - * @memberof FileSystemAttributes */ public none: boolean = false; /** * Specifies the handle identifies a directory. - * - * @type {boolean} - * @memberof FileSystemAttributes */ public directory: boolean = false; /** * Specifies a directory or file is an archive. Applications typically use this attribute to mark files for backup or removal. - * - * @type {boolean} - * @memberof FileSystemAttributes */ public archive: boolean = false; @@ -124,17 +100,11 @@ export class FileSystemAttributes { /** * Specifies the data of a directory or file is not available immediately. * This file system attribute is presented primarily to provide compatibility with Windows - Azure Files does not support with offline storage options. - * - * @type {boolean} - * @memberof FileSystemAttributes */ public offline: boolean = false; /** * Specifies the directory or file is not to be indexed by the content indexing service. - * - * @type {boolean} - * @memberof FileSystemAttributes */ public notContentIndexed: boolean = false; @@ -142,9 +112,6 @@ export class FileSystemAttributes { * Specifies the user data stream not to be read by the background data integrity scanner. * This file system attribute is presented primarily to provide compatibility with Windows. * Applicable to directory or file. - * - * @type {boolean} - * @memberof FileSystemAttributes */ public noScrubData: boolean = false; @@ -152,7 +119,6 @@ export class FileSystemAttributes { * Converts the given attributes to a string. * * @returns A string which represents the FileSystemAttributes - * @memberof FileSystemAttributes */ public toString(): string { const attributes: string[] = []; diff --git a/sdk/storage/storage-file-share/src/Pipeline.ts b/sdk/storage/storage-file-share/src/Pipeline.ts index 8a76498e7147..15361119dfb0 100644 --- a/sdk/storage/storage-file-share/src/Pipeline.ts +++ b/sdk/storage/storage-file-share/src/Pipeline.ts @@ -54,16 +54,10 @@ export { /** * Option interface for Pipeline constructor. - * - * @export - * @interface PipelineOptions */ export interface PipelineOptions { /** * Optional. Configures the HTTP client to send requests and receive responses. - * - * @type {IHttpClient} - * @memberof PipelineOptions */ httpClient?: IHttpClient; } @@ -75,23 +69,14 @@ export interface PipelineOptions { * * Refer to {@link newPipeline} and provided policies as reference before * implementing your customized Pipeline. - * - * @export - * @class Pipeline */ export class Pipeline { /** * A list of chained request policy factories. - * - * @type {RequestPolicyFactory[]} - * @memberof Pipeline */ public readonly factories: RequestPolicyFactory[]; /** * Configures pipeline logger and HTTP client. - * - * @type {PipelineOptions} - * @memberof Pipeline */ public readonly options: PipelineOptions; @@ -100,7 +85,6 @@ export class Pipeline { * * @param factories - * @param options - - * @memberof Pipeline */ constructor(factories: RequestPolicyFactory[], options: PipelineOptions = {}) { this.factories = factories; @@ -117,7 +101,6 @@ export class Pipeline { * ServiceClient constructor. * * @returns The ServiceClientOptions object from this Pipeline. - * @memberof Pipeline */ public toServiceClientOptions(): ServiceClientOptions { return { @@ -129,9 +112,6 @@ export class Pipeline { /** * Option interface for {@link newPipeline} function. - * - * @export - * @interface StoragePipelineOptions */ export interface StoragePipelineOptions { /** @@ -140,30 +120,18 @@ export interface StoragePipelineOptions { proxyOptions?: ProxyOptions; /** * Options for adding user agent details to outgoing requests. - * - * @type {UserAgentOptions} - * @memberof StoragePipelineOptions */ userAgentOptions?: UserAgentOptions; /** * Configures the built-in retry policy behavior. - * - * @type {StorageRetryOptions} - * @memberof StoragePipelineOptions */ retryOptions?: StorageRetryOptions; /** * Keep alive configurations. Default keep-alive is enabled. - * - * @type {KeepAliveOptions} - * @memberof StoragePipelineOptions */ keepAliveOptions?: KeepAliveOptions; /** * Configures the HTTP client to send requests and receive responses. - * - * @type {IHttpClient} - * @memberof StoragePipelineOptions */ httpClient?: IHttpClient; } @@ -171,11 +139,9 @@ export interface StoragePipelineOptions { /** * Creates a new {@link Pipeline} object with {@link Credential} provided. * - * @static * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential. * @param pipelineOptions - Optional. Options. * @returns A new Pipeline object. - * @memberof Pipeline */ export function newPipeline( credential?: Credential, diff --git a/sdk/storage/storage-file-share/src/Range.ts b/sdk/storage/storage-file-share/src/Range.ts index 9c6fd9f4f33d..d2953b801aad 100644 --- a/sdk/storage/storage-file-share/src/Range.ts +++ b/sdk/storage/storage-file-share/src/Range.ts @@ -5,24 +5,15 @@ /** * Range for Service Operations. * @see https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-file-service-operations - * - * @export - * @interface Range */ export interface Range { /** * StartByte, larger than or equal 0. - * - * @type {string} - * @memberof Range */ offset: number; /** * Optional. Count of bytes, larger than 0. * If not provided, will return bytes from offset to the end. - * - * @type {string} - * @memberof Range */ count?: number; } @@ -32,7 +23,6 @@ export interface Range { * * "bytes=255-" or "bytes=0-511" * - * @export * @param range - A range of byte positions. * @returns The string representation for the byte range. */ diff --git a/sdk/storage/storage-file-share/src/SASQueryParameters.ts b/sdk/storage/storage-file-share/src/SASQueryParameters.ts index d285e8bf1e75..74778dbbe461 100644 --- a/sdk/storage/storage-file-share/src/SASQueryParameters.ts +++ b/sdk/storage/storage-file-share/src/SASQueryParameters.ts @@ -6,9 +6,6 @@ import { truncatedISO8061Date } from "./utils/utils.common"; /** * Protocols for generated SAS. - * - * @export - * @enum {number} */ export enum SASProtocol { /** @@ -30,40 +27,25 @@ export enum SASProtocol { * these query parameters). * * NOTE: Instances of this class are immutable. - * - * @export - * @class SASQueryParameters */ export class SASQueryParameters { /** * The storage API version. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly version: string; /** * Optional. The allowed HTTP protocol(s). - * - * @type {SASProtocol} - * @memberof SASQueryParameters */ public readonly protocol?: SASProtocol; /** * Optional. The start time for this SAS token. - * - * @type {Date} - * @memberof SASQueryParameters */ public readonly startsOn?: Date; /** * Optional only when identifier is provided. The expiry time for this SAS token. - * - * @type {Date} - * @memberof SASQueryParameters */ public readonly expiresOn?: Date; @@ -71,27 +53,18 @@ export class SASQueryParameters { * Optional only when identifier is provided. * Please refer to {@link AccountSASPermissions}, {@link FileSASPermissions}, or {@link ShareSASPermissions} for * more details. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly permissions?: string; /** * Optional. The storage services being accessed (only for Account SAS). Please refer to {@link AccountSASServices} * for more details. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly services?: string; /** * Optional. The storage resource types being accessed (only for Account SAS). Please refer to * {@link AccountSASResourceTypes} for more details. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly resourceTypes?: string; @@ -99,74 +72,46 @@ export class SASQueryParameters { * Optional. The signed identifier (only for {@link FileSASSignatureValues}). * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy - * - * @type {string} - * @memberof SASQueryParameters */ public readonly identifier?: string; /** * Optional. The storage share or file path (only for {@link FileSASSignatureValues}). - * - * @type {string} - * @memberof SASQueryParameters */ public readonly resource?: string; /** * The signature for the SAS token. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly signature: string; /** * Value for cache-control header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly cacheControl?: string; /** * Value for content-disposition header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly contentDisposition?: string; /** * Value for content-encoding header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly contentEncoding?: string; /** * Value for content-length header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly contentLanguage?: string; /** * Value for content-type header in Blob/File Service SAS. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly contentType?: string; /** * Inner value of getter ipRange. - * - * @private - * @type {SasIPRange} - * @memberof SASQueryParameters */ private readonly ipRangeInner?: SasIPRange; @@ -174,8 +119,6 @@ export class SASQueryParameters { * Optional. IP range allowed for this SAS. * * @readonly - * @type {(SasIPRange | undefined)} - * @memberof SASQueryParameters */ public get ipRange(): SasIPRange | undefined { if (this.ipRangeInner) { @@ -206,7 +149,6 @@ export class SASQueryParameters { * @param contentEncoding - Representing the content-encoding header (only for Blob/File Service SAS) * @param contentLanguage - Representing the content-language header (only for Blob/File Service SAS) * @param contentType - Representing the content-type header (only for Blob/File Service SAS) - * @memberof SASQueryParameters */ constructor( version: string, @@ -247,8 +189,6 @@ export class SASQueryParameters { /** * Encodes all SAS query parameters into a string that can be appended to a URL. * - * - * @memberof SASQueryParameters */ public toString(): string { const params: string[] = [ @@ -341,12 +281,9 @@ export class SASQueryParameters { /** * A private helper method used to filter and append query key/value pairs into an array. * - * @private * @param queries - * @param key - * @param value - - * - * @memberof SASQueryParameters */ private tryAppendQueryParameter(queries: string[], key: string, value?: string): void { if (!value) { diff --git a/sdk/storage/storage-file-share/src/SasIPRange.ts b/sdk/storage/storage-file-share/src/SasIPRange.ts index aa66a4a92d7a..b699ab84a0b4 100644 --- a/sdk/storage/storage-file-share/src/SasIPRange.ts +++ b/sdk/storage/storage-file-share/src/SasIPRange.ts @@ -3,25 +3,16 @@ /** * Allowed IP range for a SAS. - * - * @export - * @interface SasIPRange */ export interface SasIPRange { /** * Starting IP address in the IP range. * If end IP doesn't provide, start IP will the only IP allowed. - * - * @type {string} - * @memberof SasIPRange */ start: string; /** * Optional. IP address that ends the IP range. * If not provided, start IP will the only IP allowed. - * - * @type {string} - * @memberof SasIPRange */ end?: string; } @@ -31,7 +22,6 @@ export interface SasIPRange { * * "8.8.8.8" or "1.1.1.1-255.255.255.255" * - * @export * @param ipRange - A range of IP addresses. * @returns string representation of the IP range. */ diff --git a/sdk/storage/storage-file-share/src/ShareClientInternal.ts b/sdk/storage/storage-file-share/src/ShareClientInternal.ts index 009e6f4f5812..14e80f1e4294 100644 --- a/sdk/storage/storage-file-share/src/ShareClientInternal.ts +++ b/sdk/storage/storage-file-share/src/ShareClientInternal.ts @@ -8,9 +8,6 @@ import { Share } from "./generated/src/operations"; /** * ShareClientInternal is the thin wrapper for Share which contains internal helper methods. - * - * @export - * @class ShareClientInternal */ export class ShareClientInternal extends StorageClient { private context: Share; diff --git a/sdk/storage/storage-file-share/src/ShareSASPermissions.ts b/sdk/storage/storage-file-share/src/ShareSASPermissions.ts index d87118aacadb..2c7cd0d74570 100644 --- a/sdk/storage/storage-file-share/src/ShareSASPermissions.ts +++ b/sdk/storage/storage-file-share/src/ShareSASPermissions.ts @@ -7,18 +7,13 @@ * Once all the values are set, this should be serialized with toString and set as the permissions field on a * {@link FileSASSignatureValues} 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 - * @class ShareSASPermissions */ export class ShareSASPermissions { /** * Creates an {@link ShareSASPermissions} from the specified permissions string. This method will throw an * Error if it encounters a character that does not correspond to a valid permission. * - * @static * @param permissions - - * @memberof ShareSASPermissions */ public static parse(permissions: string) { const shareSASPermissions = new ShareSASPermissions(); @@ -50,41 +45,26 @@ export class ShareSASPermissions { /** * Specifies Read access granted. - * - * @type {boolean} - * @memberof ShareSASPermissions */ public read: boolean = false; /** * Specifies Create access granted. - * - * @type {boolean} - * @memberof ShareSASPermissions */ public create: boolean = false; /** * Specifies Write access granted. - * - * @type {boolean} - * @memberof ShareSASPermissions */ public write: boolean = false; /** * Specifies Delete access granted. - * - * @type {boolean} - * @memberof ShareSASPermissions */ public delete: boolean = false; /** * Specifies List access granted. - * - * @type {boolean} - * @memberof ShareSASPermissions */ public list: boolean = false; @@ -95,8 +75,6 @@ export class ShareSASPermissions { * The order of the characters should be as specified here to ensure correctness. * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas * - * - * @memberof ShareSASPermissions */ public toString(): string { const permissions: string[] = []; diff --git a/sdk/storage/storage-file-share/src/ShareServiceClient.ts b/sdk/storage/storage-file-share/src/ShareServiceClient.ts index 5a63c1db37b1..f9d7cb272ac6 100644 --- a/sdk/storage/storage-file-share/src/ShareServiceClient.ts +++ b/sdk/storage/storage-file-share/src/ShareServiceClient.ts @@ -42,166 +42,108 @@ import { appendToURLQuery } from "./utils/utils.common"; * - {@link ShareServiceClient.listSegments} * - {@link ShareServiceClient.listItems} * - {@link ShareServiceClient.listSharesSegment} - * - * @interface ServiceListSharesSegmentOptions */ interface ServiceListSharesSegmentOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ServiceListSharesSegmentOptions */ abortSignal?: AbortSignalLike; /** * Filters the results to return only entries whose * name begins with the specified prefix. - * - * @type {string} - * @memberof ServiceListSharesSegmentOptions */ prefix?: string; /** * Specifies the maximum number of entries to * return. If the request does not specify maxResults, or specifies a value * greater than 5,000, the server will return up to 5,000 items. - * - * @type {number} - * @memberof ServiceListSharesSegmentOptions */ maxResults?: number; /** * Include this parameter to * specify one or more datasets to include in the response. - * - * @type {ListSharesIncludeType[]} - * @memberof ServiceListSharesSegmentOptions */ include?: ListSharesIncludeType[]; } /** * Options to configure the {@link ShareServiceClient.listShares} operation. - * - * @export - * @interface ServiceListSharesOptions */ export interface ServiceListSharesOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ServiceListSharesOptions */ abortSignal?: AbortSignalLike; /** * Filters the results to return only entries whose * name begins with the specified prefix. - * - * @type {string} - * @memberof ServiceListSharesOptions */ prefix?: string; /** * Specifies that share snapshots should be included in the enumeration. Share Snapshots are listed from oldest to newest in the response. - * - * @type {boolean} - * @memberof ServiceListSharesOptions */ includeMetadata?: boolean; /** * Specifies that share snapshot should be returned in the response. - * - * @type {boolean} - * @memberof ServiceListSharesOptions */ includeSnapshots?: boolean; /** * Specifies that share soft deleted should be returned in the response. - * - * @type {boolean} - * @memberof ServiceListSharesOptions */ includeDeleted?: boolean; } /** * Options to configure the {@link ShareServiceClient.getProperties} operation. - * - * @export - * @interface ServiceGetPropertiesOptions */ export interface ServiceGetPropertiesOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof AppendBlobCreateOptions */ abortSignal?: AbortSignalLike; } /** * Options to configure the {@link ShareServiceClient.setProperties} operation. - * - * @export - * @interface ServiceSetPropertiesOptions */ export interface ServiceSetPropertiesOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof AppendBlobCreateOptions */ abortSignal?: AbortSignalLike; } /** * Options to configure the {@link ShareServiceClient.undelete} operation. - * - * @export - * @interface ServiceUndeleteShareOptions */ export interface ServiceUndeleteShareOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ServiceUndeleteShareOptions */ abortSignal?: AbortSignalLike; } /** * Properties of a share. - * - * @export - * @interface ShareProperties */ export type ShareProperties = SharePropertiesInternal & { /** * The protocols that have been enabled on the share. - * @type {ShareProtocols} - * @memberof ShareProperties */ protocols?: ShareProtocols; }; /** * A listed Azure Storage share item. - * - * @export - * @interface ShareItem */ export interface ShareItem { name: string; @@ -252,40 +194,25 @@ export type ServiceListSharesSegmentResponse = ListSharesResponse & /** * Options to configure {@link ShareServiceClient.generateAccountSasUrl} operation. - * - * @export - * @interface ServiceGenerateAccountSasUrlOptions */ export interface ServiceGenerateAccountSasUrlOptions { /** * 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 ServiceGenerateAccountSasUrlOptions */ version?: string; /** * Optional. SAS protocols allowed. - * - * @type {SASProtocol} - * @memberof ServiceGenerateAccountSasUrlOptions */ protocol?: SASProtocol; /** * Optional. When the SAS will take effect. - * - * @type {Date} - * @memberof ServiceGenerateAccountSasUrlOptions */ startsOn?: Date; /** * Optional. IP range allowed. - * - * @type {SasIPRange} - * @memberof ServiceGenerateAccountSasUrlOptions */ ipRange?: SasIPRange; } @@ -293,17 +220,10 @@ export interface ServiceGenerateAccountSasUrlOptions { /** * A ShareServiceClient represents a URL to the Azure Storage File service allowing you * to manipulate file shares. - * - * @export - * @class ShareServiceClient */ export class ShareServiceClient extends StorageClient { /** * serviceContext provided by protocol layer. - * - * @private - * @type {Service} - * @memberof ShareServiceClient */ private serviceContext: Service; @@ -319,7 +239,6 @@ export class ShareServiceClient extends StorageClient { * `BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString` * @param options - Options to configure the HTTP pipeline. * @returns A new ShareServiceClient from the given connection string. - * @memberof ShareServiceClient */ public static fromConnectionString( connectionString: string, @@ -356,7 +275,6 @@ export class ShareServiceClient extends StorageClient { * @param credential - Such as AnonymousCredential or StorageSharedKeyCredential. * If not specified, AnonymousCredential is used. * @param options - Optional. Options to configure the HTTP pipeline. - * @memberof ShareServiceClient */ constructor(url: string, credential?: Credential, options?: StoragePipelineOptions); /** @@ -367,7 +285,6 @@ export class ShareServiceClient extends StorageClient { * if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString". * @param pipeline - Call newPipeline() to create a default * pipeline, or provide a customized pipeline. - * @memberof ShareServiceClient */ constructor(url: string, pipeline: Pipeline); constructor( @@ -392,9 +309,8 @@ export class ShareServiceClient extends StorageClient { /** * Creates a ShareClient object. * - * @param shareName Name of a share. + * @param shareName - Name of a share. * @returns The ShareClient object for the given share name. - * @memberof ShareServiceClient * * Example usage: * @@ -414,7 +330,6 @@ export class ShareServiceClient extends StorageClient { * @param shareName - * @param options - * @returns Share creation response and the corresponding share client. - * @memberof ShareServiceClient */ public async createShare( shareName: string, @@ -451,7 +366,6 @@ export class ShareServiceClient extends StorageClient { * @param shareName - * @param options - * @returns Share deletion response and the corresponding share client. - * @memberof ShareServiceClient */ public async deleteShare( shareName: string, @@ -481,11 +395,10 @@ export class ShareServiceClient extends StorageClient { /** * Gets the properties of a storage account’s file service, including properties * for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. - * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-file-service-properties} + * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-file-service-properties * * @param options - Options to Get Properties operation. * @returns Response data for the Get Properties operation. - * @memberof ShareServiceClient */ public async getProperties( options: ServiceGetPropertiesOptions = {} @@ -513,12 +426,11 @@ export class ShareServiceClient extends StorageClient { /** * Sets properties for a storage account’s file service endpoint, including properties * for Storage Analytics, CORS (Cross-Origin Resource Sharing) rules and soft delete settings. - * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-service-properties} + * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-service-properties * * @param properties - * @param options - Options to Set Properties operation. * @returns Response data for the Set Properties operation. - * @memberof ShareServiceClient */ public async setProperties( properties: FileServiceProperties, @@ -547,7 +459,6 @@ export class ShareServiceClient extends StorageClient { /** * Returns an AsyncIterableIterator for {@link ServiceListSharesSegmentResponse} objects * - * @private * @param marker - A string value that identifies the portion of * the list of shares to be returned with the next listing operation. The * operation returns the ContinuationToken value within the response body if the @@ -556,8 +467,6 @@ export class ShareServiceClient extends StorageClient { * the marker parameter in a subsequent call to request the next page of list * items. The marker value is opaque to the client. * @param options - Options to list shares operation. - * - * @memberof ShareServiceClient */ private async *listSegments( marker?: string, @@ -578,10 +487,7 @@ export class ShareServiceClient extends StorageClient { /** * Returns an AsyncIterableIterator for share items * - * @private * @param options - Options to list shares operation. - * - * @memberof ShareServiceClient */ private async *listItems( options: ServiceListSharesSegmentOptions = {} @@ -669,7 +575,6 @@ export class ShareServiceClient extends StorageClient { * ``` * * @param options - Options to list shares operation. - * @memberof ShareServiceClient * * An asyncIterableIterator that supports paging. */ @@ -700,19 +605,19 @@ export class ShareServiceClient extends StorageClient { const iter = this.listItems(updatedOptions); return { /** - * @member {Promise} [next] The next method, part of the iteration protocol + * The next method, part of the iteration protocol */ next() { return iter.next(); }, /** - * @member {Symbol} [asyncIterator] The connection to the async iterator, part of the iteration protocol + * The connection to the async iterator, part of the iteration protocol */ [Symbol.asyncIterator]() { return this; }, /** - * @member {Function} [byPage] Return an AsyncIterableIterator that works a page at a time + * Return an AsyncIterableIterator that works a page at a time */ byPage: (settings: PageSettings = {}) => { return this.listSegments(settings.continuationToken, { @@ -735,7 +640,6 @@ export class ShareServiceClient extends StorageClient { * client. * @param options - Options to List Shares Segment operation. * @returns Response data for the List Shares Segment operation. - * @memberof ShareServiceClient */ private async listSharesSegment( marker?: string, @@ -782,11 +686,10 @@ export class ShareServiceClient extends StorageClient { * This API is only functional if Share Soft Delete is enabled * for the storage account associated with the share. * - * @param deletedShareName The name of the previously deleted share. - * @param deletedShareVersion The version of the previously deleted share. + * @param deletedShareName - The name of the previously deleted share. + * @param deletedShareVersion - The version of the previously deleted share. * @param options - Options to Share undelete operation. * @returns Restored share. - * @memberof ShareServiceClient */ public async undeleteShare( deletedShareName: string, @@ -830,7 +733,6 @@ export class ShareServiceClient extends StorageClient { * @param resourceTypes - Specifies the resource types associated with the shared access signature. * @param options - Optional parameters. * @returns An account SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token. - * @memberof ShareServiceClient */ public generateAccountSasUrl( expiresOn?: Date, diff --git a/sdk/storage/storage-file-share/src/StorageBrowserPolicyFactory.ts b/sdk/storage/storage-file-share/src/StorageBrowserPolicyFactory.ts index 348094e8f2db..c61e4479b0fb 100644 --- a/sdk/storage/storage-file-share/src/StorageBrowserPolicyFactory.ts +++ b/sdk/storage/storage-file-share/src/StorageBrowserPolicyFactory.ts @@ -7,10 +7,6 @@ export { StorageBrowserPolicy }; /** * StorageBrowserPolicyFactory is a factory class helping generating BrowserPolicy objects. - * - * @export - * @class StorageBrowserPolicyFactory - * @implements {RequestPolicyFactory} */ export class StorageBrowserPolicyFactory implements RequestPolicyFactory { /** @@ -18,8 +14,6 @@ export class StorageBrowserPolicyFactory implements RequestPolicyFactory { * * @param nextPolicy - * @param options - - * - * @memberof StorageBrowserPolicyFactory */ public create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageBrowserPolicy { return new StorageBrowserPolicy(nextPolicy, options); diff --git a/sdk/storage/storage-file-share/src/StorageClient.ts b/sdk/storage/storage-file-share/src/StorageClient.ts index 441c3f56264d..149b1ab226f4 100644 --- a/sdk/storage/storage-file-share/src/StorageClient.ts +++ b/sdk/storage/storage-file-share/src/StorageClient.ts @@ -20,16 +20,10 @@ export interface CommonOptions { /** * A StorageClient represents a base client class for ServiceClient, ContainerClient and etc. - * - * @export - * @class StorageClient */ export abstract class StorageClient { /** * URL string value. - * - * @type {string} - * @memberof StorageClient */ public readonly url: string; public readonly accountName: string; @@ -38,9 +32,6 @@ export abstract class StorageClient { * Request policy pipeline. * * @internal - * @hidden - * @type {Pipeline} - * @memberof StorageClient */ protected readonly pipeline: Pipeline; @@ -49,19 +40,12 @@ export abstract class StorageClient { * Initialized to an AnonymousCredential if not able to retrieve it from the pipeline. * * @internal - * @hidden - * @type {Credential} - * @memberof StorageClient */ protected readonly credential: Credential; /** * StorageClient is a reference to protocol layer operations entry, which is * generated by AutoRest generator. - * - * @protected - * @type {StorageClientContext} - * @memberof StorageClient */ protected readonly storageClientContext: StorageClientContext; @@ -69,7 +53,6 @@ export abstract class StorageClient { * Creates an instance of StorageClient. * @param url - * @param pipeline - - * @memberof StorageClient */ protected constructor(url: string, pipeline: Pipeline) { // URL should be encoded and only once, protocol layer shouldn't encode URL again diff --git a/sdk/storage/storage-file-share/src/StorageRetryPolicyFactory.ts b/sdk/storage/storage-file-share/src/StorageRetryPolicyFactory.ts index 0fcb1f798013..bb74610f4bf5 100644 --- a/sdk/storage/storage-file-share/src/StorageRetryPolicyFactory.ts +++ b/sdk/storage/storage-file-share/src/StorageRetryPolicyFactory.ts @@ -8,16 +8,10 @@ export { StorageRetryPolicyType, StorageRetryPolicy }; /** * Retry options interface. - * - * @export - * @interface StorageRetryOptions */ export interface StorageRetryOptions { /** * Optional. StorageRetryPolicyType, default is exponential retry policy. - * - * @type {StorageRetryPolicyType} - * @memberof StorageRetryOptions */ readonly retryPolicyType?: StorageRetryPolicyType; @@ -25,9 +19,6 @@ export interface StorageRetryOptions { * Optional. Max try number of attempts, default is 4. * A value of 1 means 1 try and no retries. * A value smaller than 1 means default retry number of attempts. - * - * @type {number} - * @memberof StorageRetryOptions */ readonly maxTries?: number; @@ -39,9 +30,6 @@ export interface StorageRetryOptions { * not be sufficient. You should override this value based on the bandwidth available to * the host machine and proximity to the Storage service. A good starting point may be something * like (60 seconds per MB of anticipated-payload-size) - * - * @type {number} - * @memberof StorageRetryOptions */ readonly tryTimeoutInMs?: number; @@ -49,28 +37,18 @@ export interface StorageRetryOptions { * Optional. Specifies the amount of delay to use before retrying an operation (default is 4s or 4 * 1000ms). * The delay increases (exponentially or linearly) with each retry up to a maximum specified by * maxRetryDelayInMs. If you specify 0, then you must also specify 0 for maxRetryDelayInMs. - * - * @type {number} - * @memberof StorageRetryOptions */ readonly retryDelayInMs?: number; /** * Optional. Specifies the maximum delay allowed before retrying an operation (default is 120s or 120 * 1000ms). * If you specify 0, then you must also specify 0 for retryDelayInMs. - * - * @type {number} - * @memberof StorageRetryOptions */ readonly maxRetryDelayInMs?: number; } /** * StorageRetryPolicyFactory is a factory class helping generating StorageRetryPolicy objects. - * - * @export - * @class StorageRetryPolicyFactory - * @implements {RequestPolicyFactory} */ export class StorageRetryPolicyFactory implements RequestPolicyFactory { private retryOptions?: StorageRetryOptions; @@ -78,7 +56,6 @@ export class StorageRetryPolicyFactory implements RequestPolicyFactory { /** * Creates an instance of StorageRetryPolicyFactory. * @param retryOptions - - * @memberof StorageRetryPolicyFactory */ constructor(retryOptions?: StorageRetryOptions) { this.retryOptions = retryOptions; @@ -88,8 +65,6 @@ export class StorageRetryPolicyFactory implements RequestPolicyFactory { * Creates a StorageRetryPolicy object. * @param nextPolicy - * @param options - - * - * @memberof StorageRetryPolicyFactory */ public create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageRetryPolicy { return new StorageRetryPolicy(nextPolicy, options, this.retryOptions); diff --git a/sdk/storage/storage-file-share/src/TelemetryPolicyFactory.ts b/sdk/storage/storage-file-share/src/TelemetryPolicyFactory.ts index be9ecbf8fb87..dfdf1b2da9a2 100644 --- a/sdk/storage/storage-file-share/src/TelemetryPolicyFactory.ts +++ b/sdk/storage/storage-file-share/src/TelemetryPolicyFactory.ts @@ -15,22 +15,16 @@ import { SDK_VERSION } from "./utils/constants"; /** * TelemetryPolicyFactory is a factory class helping generating {@link TelemetryPolicy} objects. - * - * @export - * @class TelemetryPolicyFactory - * @implements {RequestPolicyFactory} */ export class TelemetryPolicyFactory implements RequestPolicyFactory { /** * @internal - * @hidden */ public readonly telemetryString: string; /** * Creates an instance of TelemetryPolicyFactory. * @param telemetry - - * @memberof TelemetryPolicyFactory */ constructor(telemetry?: UserAgentOptions) { const userAgentInfo: string[] = []; @@ -64,8 +58,6 @@ export class TelemetryPolicyFactory implements RequestPolicyFactory { * * @param nextPolicy - * @param options - - * - * @memberof TelemetryPolicyFactory */ public create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): TelemetryPolicy { return new TelemetryPolicy(nextPolicy, options, this.telemetryString); diff --git a/sdk/storage/storage-file-share/src/credentials/AnonymousCredential.ts b/sdk/storage/storage-file-share/src/credentials/AnonymousCredential.ts index f5ecc357c499..e5ce6a7c2e98 100644 --- a/sdk/storage/storage-file-share/src/credentials/AnonymousCredential.ts +++ b/sdk/storage/storage-file-share/src/credentials/AnonymousCredential.ts @@ -11,10 +11,6 @@ import { Credential } from "./Credential"; * {@link AnonymousCredentialPolicy} objects. AnonymousCredentialPolicy is used with * HTTP(S) requests that read public resources or for use with Shared Access * Signatures (SAS). - * - * @export - * @class AnonymousCredential - * @extends {Credential} */ export class AnonymousCredential extends Credential { /** @@ -22,8 +18,6 @@ export class AnonymousCredential extends Credential { * * @param nextPolicy - * @param options - - * - * @memberof AnonymousCredential */ public create( nextPolicy: RequestPolicy, diff --git a/sdk/storage/storage-file-share/src/credentials/Credential.ts b/sdk/storage/storage-file-share/src/credentials/Credential.ts index 8cc556d37638..ec1bee135c2c 100644 --- a/sdk/storage/storage-file-share/src/credentials/Credential.ts +++ b/sdk/storage/storage-file-share/src/credentials/Credential.ts @@ -7,10 +7,6 @@ import { CredentialPolicy } from "../policies/CredentialPolicy"; /** * Credential is an abstract class for Azure Storage HTTP requests signing. This * class will host an credentialPolicyCreator factory which generates CredentialPolicy. - * - * @export - * @abstract - * @class Credential */ export abstract class Credential implements RequestPolicyFactory { /** @@ -18,8 +14,6 @@ export abstract class Credential implements RequestPolicyFactory { * * @param _nextPolicy - * @param _options - - * - * @memberof Credential */ public create( // tslint:disable-next-line:variable-name diff --git a/sdk/storage/storage-file-share/src/credentials/StorageSharedKeyCredential.ts b/sdk/storage/storage-file-share/src/credentials/StorageSharedKeyCredential.ts index eab8c80a9763..0b047c493e0b 100644 --- a/sdk/storage/storage-file-share/src/credentials/StorageSharedKeyCredential.ts +++ b/sdk/storage/storage-file-share/src/credentials/StorageSharedKeyCredential.ts @@ -11,25 +11,15 @@ import { Credential } from "./Credential"; * ONLY AVAILABLE IN NODE.JS RUNTIME. * * StorageSharedKeyCredential for account key authorization of Azure Storage service. - * - * @export - * @class StorageSharedKeyCredential - * @extends {Credential} */ export class StorageSharedKeyCredential extends Credential { /** * Azure Storage account name; readonly. - * - * @type {string} - * @memberof StorageSharedKeyCredential */ public readonly accountName: string; /** * Azure Storage account key; readonly. - * - * @type {Buffer} - * @memberof StorageSharedKeyCredential */ private readonly accountKey: Buffer; @@ -37,7 +27,6 @@ export class StorageSharedKeyCredential extends Credential { * Creates an instance of StorageSharedKeyCredential. * @param accountName - * @param accountKey - - * @memberof StorageSharedKeyCredential */ constructor(accountName: string, accountKey: string) { super(); @@ -50,8 +39,6 @@ export class StorageSharedKeyCredential extends Credential { * * @param nextPolicy - * @param options - - * - * @memberof StorageSharedKeyCredential */ public create( nextPolicy: RequestPolicy, @@ -64,8 +51,6 @@ export class StorageSharedKeyCredential extends Credential { * Generates a hash signature for an HTTP request or for a SAS. * * @param stringToSign - - * - * @memberof StorageSharedKeyCredential */ public computeHMACSHA256(stringToSign: string): string { return createHmac("sha256", this.accountKey) diff --git a/sdk/storage/storage-file-share/src/log.ts b/sdk/storage/storage-file-share/src/log.ts index 343027942df8..418ce5c32bfb 100644 --- a/sdk/storage/storage-file-share/src/log.ts +++ b/sdk/storage/storage-file-share/src/log.ts @@ -4,6 +4,6 @@ import { createClientLogger } from "@azure/logger"; /** - * The @azure/logger configuration for this package. + * The `@azure/logger` configuration for this package. */ export const logger = createClientLogger("storage-file-share"); diff --git a/sdk/storage/storage-file-share/src/models.ts b/sdk/storage/storage-file-share/src/models.ts index 55b5e66bb355..4be88f704863 100644 --- a/sdk/storage/storage-file-share/src/models.ts +++ b/sdk/storage/storage-file-share/src/models.ts @@ -10,37 +10,37 @@ export interface Metadata { export interface FileHttpHeaders { /** - * @member {string} [fileCacheControl] Optional. Sets the file's cache + * Optional. Sets the file's cache * control. If specified, this property is stored with the file and returned * with a read request. */ fileCacheControl?: string; /** - * @member {string} [fileContentType] Optional. Sets the file's content type. + * Optional. Sets the file's content type. * If specified, this property is stored with the file and returned with a * read request. */ fileContentType?: string; /** - * @member {Uint8Array} [fileContentMD5] Optional. An MD5 hash of the file + * Optional. An MD5 hash of the file * content. Note that this hash is not validated, as the hashes for the * individual blocks were validated when each was uploaded. */ fileContentMD5?: Uint8Array; /** - * @member {string} [fileContentEncoding] Optional. Sets the file's content + * Optional. Sets the file's content * encoding. If specified, this property is stored with the file and returned * with a read request. */ fileContentEncoding?: string; /** - * @member {string} [fileContentLanguage] Optional. Set the file's content + * Optional. Set the file's content * language. If specified, this property is stored with the file and returned * with a read request. */ fileContentLanguage?: string; /** - * @member {string} [fileContentDisposition] Optional. Sets the file's + * Optional. Sets the file's * Content-Disposition header. */ fileContentDisposition?: string; @@ -152,9 +152,6 @@ export interface FileAndDirectorySetPropertiesCommonOptions { /** * Close handles result information. - * - * @export - * @interface CloseHandlesInfo */ export interface CloseHandlesInfo { closedHandlesCount: number; @@ -166,22 +163,14 @@ export interface CloseHandlesInfo { /** * Protocols to enable on the share. For now, only support SMB or NFS. - * @export - * @interface ShareProtocols */ export interface ShareProtocols { /** * The share can be accessed by SMBv3.0, SMBv2.1 and REST. - * - * @type {boolean} - * @memberof ShareProtocols */ smbEnabled?: boolean; /** * The share can be accessed by NFSv4.1. - * - * @type {boolean} - * @memberof ShareProtocols */ nfsEnabled?: boolean; } @@ -189,9 +178,7 @@ export interface ShareProtocols { /** * Convert protocols from joined string to ShareProtocols. * - * @export * @param protocolsString - - * */ export function toShareProtocols(protocolsString?: string): ShareProtocols | undefined { if (protocolsString === undefined) { @@ -213,9 +200,7 @@ export function toShareProtocols(protocolsString?: string): ShareProtocols | und /** * Convert ShareProtocols to joined string. * - * @export * @param protocols - - * */ export function toShareProtocolsString(protocols: ShareProtocols = {}): string | undefined { let protocolStr = undefined; diff --git a/sdk/storage/storage-file-share/src/policies/AnonymousCredentialPolicy.ts b/sdk/storage/storage-file-share/src/policies/AnonymousCredentialPolicy.ts index 743528139e91..08e4118ad4c0 100644 --- a/sdk/storage/storage-file-share/src/policies/AnonymousCredentialPolicy.ts +++ b/sdk/storage/storage-file-share/src/policies/AnonymousCredentialPolicy.ts @@ -8,17 +8,12 @@ import { CredentialPolicy } from "./CredentialPolicy"; /** * AnonymousCredentialPolicy is used with HTTP(S) requests that read public resources * or for use with Shared Access Signatures (SAS). - * - * @export - * @class AnonymousCredentialPolicy - * @extends {CredentialPolicy} */ export class AnonymousCredentialPolicy extends CredentialPolicy { /** * Creates an instance of AnonymousCredentialPolicy. * @param nextPolicy - * @param options - - * @memberof AnonymousCredentialPolicy */ constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions) { super(nextPolicy, options); diff --git a/sdk/storage/storage-file-share/src/policies/CredentialPolicy.ts b/sdk/storage/storage-file-share/src/policies/CredentialPolicy.ts index e8796c296e71..a0866f5705f3 100644 --- a/sdk/storage/storage-file-share/src/policies/CredentialPolicy.ts +++ b/sdk/storage/storage-file-share/src/policies/CredentialPolicy.ts @@ -6,19 +6,12 @@ import { BaseRequestPolicy, HttpOperationResponse, WebResource } from "@azure/co /** * Credential policy used to sign HTTP(S) requests before sending. This is an * abstract class. - * - * @export - * @abstract - * @class CredentialPolicy - * @extends {BaseRequestPolicy} */ export abstract class CredentialPolicy extends BaseRequestPolicy { /** * Sends out request. * * @param request - - * - * @memberof CredentialPolicy */ public sendRequest(request: WebResource): Promise { return this._nextPolicy.sendRequest(this.signRequest(request)); @@ -28,11 +21,7 @@ export abstract class CredentialPolicy extends BaseRequestPolicy { * Child classes must implement this method with request signing. This method * will be executed in {@link sendRequest}. * - * @protected - * @abstract * @param request - - * - * @memberof CredentialPolicy */ protected signRequest(request: WebResource): WebResource { // Child classes must override this method with request signing. This method diff --git a/sdk/storage/storage-file-share/src/policies/StorageBrowserPolicy.ts b/sdk/storage/storage-file-share/src/policies/StorageBrowserPolicy.ts index 5e26f9d13903..35748194822e 100644 --- a/sdk/storage/storage-file-share/src/policies/StorageBrowserPolicy.ts +++ b/sdk/storage/storage-file-share/src/policies/StorageBrowserPolicy.ts @@ -23,16 +23,12 @@ import { setURLParameter } from "../utils/utils.common"; * 2. Remove cookie header for security * * 3. Remove content-length header to avoid browsers warning - * - * @class StorageBrowserPolicy - * @extends {BaseRequestPolicy} */ export class StorageBrowserPolicy extends BaseRequestPolicy { /** * Creates an instance of StorageBrowserPolicy. * @param nextPolicy - * @param options - - * @memberof StorageBrowserPolicy */ constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions) { super(nextPolicy, options); @@ -42,8 +38,6 @@ export class StorageBrowserPolicy extends BaseRequestPolicy { * Sends out request. * * @param request - - * - * @memberof StorageBrowserPolicy */ public async sendRequest(request: WebResource): Promise { if (isNode) { diff --git a/sdk/storage/storage-file-share/src/policies/StorageRetryPolicy.ts b/sdk/storage/storage-file-share/src/policies/StorageRetryPolicy.ts index 939fa7331ca5..c969a8f7168c 100644 --- a/sdk/storage/storage-file-share/src/policies/StorageRetryPolicy.ts +++ b/sdk/storage/storage-file-share/src/policies/StorageRetryPolicy.ts @@ -22,7 +22,6 @@ import { logger } from "../log"; /** * A factory method used to generated a RetryPolicy factory. * - * @export * @param retryOptions - */ export function NewStorageRetryPolicyFactory( @@ -37,9 +36,6 @@ export function NewStorageRetryPolicyFactory( /** * RetryPolicy types. - * - * @export - * @enum {number} */ export enum StorageRetryPolicyType { /** @@ -65,17 +61,10 @@ const RETRY_ABORT_ERROR = new AbortError("The operation was aborted."); /** * Retry policy with exponential retry and linear retry implemented. - * - * @class RetryPolicy - * @extends {BaseRequestPolicy} */ export class StorageRetryPolicy extends BaseRequestPolicy { /** * RetryOptions. - * - * @private - * @type {RetryOptions} - * @memberof StorageRetryPolicy */ private readonly retryOptions: StorageRetryOptions; @@ -85,7 +74,6 @@ export class StorageRetryPolicy extends BaseRequestPolicy { * @param nextPolicy - * @param options - * @param retryOptions - - * @memberof StorageRetryPolicy */ constructor( nextPolicy: RequestPolicy, @@ -131,8 +119,6 @@ export class StorageRetryPolicy extends BaseRequestPolicy { * Sends request. * * @param request - - * - * @memberof StorageRetryPolicy */ public async sendRequest(request: WebResource): Promise { return this.attemptSendRequest(request, false, 1); @@ -141,7 +127,6 @@ export class StorageRetryPolicy extends BaseRequestPolicy { /** * Decide and perform next retry. Won't mutate request parameter. * - * @protected * @param request - * @param response - * @param secondaryHas404 - If attempt was against the secondary & it returned a StatusNotFound (404), then @@ -149,8 +134,6 @@ export class StorageRetryPolicy extends BaseRequestPolicy { * case, we'll never try the secondary again for this operation. * @param attempt - How many retries has been attempted to performed, starting from 1, which includes * the attempt will be performed by this method call. - * - * @memberof StorageRetryPolicy */ protected async attemptSendRequest( request: WebResource, @@ -193,13 +176,10 @@ export class StorageRetryPolicy extends BaseRequestPolicy { /** * Decide whether to retry according to last HTTP response and retry counters. * - * @protected * @param isPrimaryRetry - * @param attempt - * @param response - * @param err - - * - * @memberof StorageRetryPolicy */ protected shouldRetry( isPrimaryRetry: boolean, @@ -271,11 +251,9 @@ export class StorageRetryPolicy extends BaseRequestPolicy { /** * Delay a calculated time between retries. * - * @private * @param isPrimaryRetry - * @param attempt - * @param abortSignal - - * @memberof StorageRetryPolicy */ private async delay(isPrimaryRetry: boolean, attempt: number, abortSignal?: AbortSignalLike) { let delayTimeInMs: number = 0; diff --git a/sdk/storage/storage-file-share/src/policies/StorageSharedKeyCredentialPolicy.ts b/sdk/storage/storage-file-share/src/policies/StorageSharedKeyCredentialPolicy.ts index 24d9ce83327d..ac18f4335e8a 100644 --- a/sdk/storage/storage-file-share/src/policies/StorageSharedKeyCredentialPolicy.ts +++ b/sdk/storage/storage-file-share/src/policies/StorageSharedKeyCredentialPolicy.ts @@ -9,17 +9,10 @@ import { CredentialPolicy } from "./CredentialPolicy"; /** * StorageSharedKeyCredentialPolicy is a policy used to sign HTTP request with a shared key. - * - * @export - * @class StorageSharedKeyCredentialPolicy - * @extends {CredentialPolicy} */ export class StorageSharedKeyCredentialPolicy extends CredentialPolicy { /** * Reference to {@link StorageSharedKeyCredential} which generates StorageSharedKeyCredentialPolicy - * - * @type {StorageSharedKeyCredential} - * @memberof StorageSharedKeyCredentialPolicy */ private readonly factory: StorageSharedKeyCredential; @@ -28,7 +21,6 @@ export class StorageSharedKeyCredentialPolicy extends CredentialPolicy { * @param nextPolicy - * @param options - * @param factory - - * @memberof StorageSharedKeyCredentialPolicy */ constructor( nextPolicy: RequestPolicy, @@ -42,10 +34,7 @@ export class StorageSharedKeyCredentialPolicy extends CredentialPolicy { /** * Signs request. * - * @protected * @param request - - * - * @memberof StorageSharedKeyCredentialPolicy */ protected signRequest(request: WebResource): WebResource { request.headers.set(HeaderConstants.X_MS_DATE, new Date().toUTCString()); @@ -90,11 +79,8 @@ export class StorageSharedKeyCredentialPolicy extends CredentialPolicy { * Retrieve header value according to shared key sign rules. * @see https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key * - * @private * @param request - * @param headerName - - * - * @memberof StorageSharedKeyCredentialPolicy */ private getHeaderValueToSign(request: WebResource, headerName: string): string { const value = request.headers.get(headerName); @@ -124,10 +110,7 @@ export class StorageSharedKeyCredentialPolicy extends CredentialPolicy { * 6. Finally, append a new-line character to each canonicalized header in the resulting list. * Construct the CanonicalizedHeaders string by concatenating all headers in this list into a single string. * - * @private * @param request - - * - * @memberof StorageSharedKeyCredentialPolicy */ private getCanonicalizedHeadersString(request: WebResource): string { let headersArray = request.headers.headersArray().filter((value) => { @@ -159,10 +142,7 @@ export class StorageSharedKeyCredentialPolicy extends CredentialPolicy { /** * Retrieves the webResource canonicalized resource string. * - * @private * @param request - - * - * @memberof StorageSharedKeyCredentialPolicy */ private getCanonicalizedResourceString(request: WebResource): string { const path = getURLPath(request.url) || "/"; diff --git a/sdk/storage/storage-file-share/src/policies/TelemetryPolicy.ts b/sdk/storage/storage-file-share/src/policies/TelemetryPolicy.ts index 519397076b4e..8ec37fecc2c7 100644 --- a/sdk/storage/storage-file-share/src/policies/TelemetryPolicy.ts +++ b/sdk/storage/storage-file-share/src/policies/TelemetryPolicy.ts @@ -15,16 +15,10 @@ import { HeaderConstants } from "../utils/constants"; /** * TelemetryPolicy is a policy used to tag user-agent header for every requests. - * - * @class TelemetryPolicy - * @extends {BaseRequestPolicy} */ export class TelemetryPolicy extends BaseRequestPolicy { /** * Telemetry string. - * - * @type {string} - * @memberof TelemetryPolicy */ public readonly telemetry: string; @@ -33,7 +27,6 @@ export class TelemetryPolicy extends BaseRequestPolicy { * @param nextPolicy - * @param options - * @param telemetry - - * @memberof TelemetryPolicy */ constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, telemetry: string) { super(nextPolicy, options); @@ -44,8 +37,6 @@ export class TelemetryPolicy extends BaseRequestPolicy { * Sends out request. * * @param request - - * - * @memberof TelemetryPolicy */ public async sendRequest(request: WebResource): Promise { if (isNode) { diff --git a/sdk/storage/storage-file-share/src/utils/Batch.ts b/sdk/storage/storage-file-share/src/utils/Batch.ts index e1402136d5b3..4dc05d4e622a 100644 --- a/sdk/storage/storage-file-share/src/utils/Batch.ts +++ b/sdk/storage/storage-file-share/src/utils/Batch.ts @@ -12,8 +12,6 @@ export declare type Operation = () => Promise; /** * States for Batch. - * - * @enum {number} */ enum BatchStates { Good, @@ -24,78 +22,47 @@ enum BatchStates { * Batch provides basic parallel execution with concurrency limits. * Will stop execute left operations when one of the executed operation throws an error. * But Batch cannot cancel ongoing operations, you need to cancel them by yourself. - * - * @export - * @class Batch */ export class Batch { /** * Concurrency. Must be lager than 0. - * - * @type {number} - * @memberof Batch */ private concurrency: number; /** * Number of active operations under execution. - * - * @private - * @type {number} - * @memberof Batch */ private actives: number = 0; /** * Number of completed operations under execution. - * - * @private - * @type {number} - * @memberof Batch */ private completed: number = 0; /** * Offset of next operation to be executed. - * - * @private - * @type {number} - * @memberof Batch */ private offset: number = 0; /** * Operation array to be executed. - * - * @private - * @type {Operation[]} - * @memberof Batch */ private operations: Operation[] = []; /** * States of Batch. When an error happens, state will turn into error. * Batch will stop execute left operations. - * - * @private - * @type {BatchStates} - * @memberof Batch */ private state: BatchStates = BatchStates.Good; /** * A private emitter used to pass events inside this class. - * - * @private - * @type {EventEmitter} - * @memberof Batch */ private emitter: EventEmitter; /** * Creates an instance of Batch. * @param concurrency - - * @memberof Batch */ public constructor(concurrency: number = 5) { if (concurrency < 1) { @@ -109,7 +76,6 @@ export class Batch { * Add a operation into queue. * * @param operation - - * @memberof Batch */ public addOperation(operation: Operation): void { this.operations.push(async () => { @@ -128,8 +94,6 @@ export class Batch { /** * Start execute operations in the queue. * - * - * @memberof Batch */ public async do(): Promise { if (this.operations.length === 0) { @@ -151,9 +115,6 @@ export class Batch { /** * Get next operation to be executed. Return null when reaching ends. * - * @private - * - * @memberof Batch */ private nextOperation(): Operation | null { if (this.offset < this.operations.length) { @@ -166,9 +127,6 @@ export class Batch { * Start execute operations. One one the most important difference between * this method with do() is that do() wraps as an sync method. * - * @private - * - * @memberof Batch */ private parallelExecute(): void { if (this.state === BatchStates.Error) { diff --git a/sdk/storage/storage-file-share/src/utils/BufferScheduler.ts b/sdk/storage/storage-file-share/src/utils/BufferScheduler.ts index 459908adc758..f5131d0dfb33 100644 --- a/sdk/storage/storage-file-share/src/utils/BufferScheduler.ts +++ b/sdk/storage/storage-file-share/src/utils/BufferScheduler.ts @@ -21,7 +21,7 @@ export declare type OutgoingHandler = (buffer: Buffer, offset?: number) => Promi * * NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING * - * NUM_OF_ALL_BUFFERS <= maxBuffers + * NUM_OF_ALL_BUFFERS lesser than or equal to maxBuffers * * PERFORMANCE IMPROVEMENT TIPS: * 1. Input stream highWaterMark is better to set a same value with bufferSize @@ -30,117 +30,67 @@ export declare type OutgoingHandler = (buffer: Buffer, offset?: number) => Promi * reduce the possibility when a outgoing handler waits for the stream data. * in this situation, outgoing handlers are blocked. * Outgoing queue shouldn't be empty. - * @export - * @class BufferScheduler */ export class BufferScheduler { /** * Size of buffers in incoming and outgoing queues. This class will try to align * data read from Readable stream into buffer chunks with bufferSize defined. - * - * @private - * @type {number} - * @memberof BufferScheduler */ private readonly bufferSize: number; /** * How many buffers can be created or maintained. - * - * @private - * @type {number} - * @memberof BufferScheduler */ private readonly maxBuffers: number; /** * A Node.js Readable stream. - * - * @private - * @type {Readable} - * @memberof BufferScheduler */ private readonly readable: Readable; /** * OutgoingHandler is an async function triggered by BufferScheduler when there * are available buffers in outgoing array. - * - * @private - * @type {OutgoingHandler} - * @memberof BufferScheduler */ private readonly outgoingHandler: OutgoingHandler; /** * An internal event emitter. - * - * @private - * @type {EventEmitter} - * @memberof BufferScheduler */ private readonly emitter: EventEmitter = new EventEmitter(); /** - * Concurrency of executing outgoingHandlers. (0 < concurrency <= maxBuffers) - * - * @private - * @type {number} - * @memberof BufferScheduler + * Concurrency of executing outgoingHandlers. (0 lesser than concurrency lesser than or equal to maxBuffers) */ private readonly concurrency: number; /** * An internal offset marker to track data offset in bytes of next outgoingHandler. - * - * @private - * @type {number} - * @memberof BufferScheduler */ private offset: number = 0; /** * An internal marker to track whether stream is end. - * - * @private - * @type {boolean} - * @memberof BufferScheduler */ private isStreamEnd: boolean = false; /** * An internal marker to track whether stream or outgoingHandler returns error. - * - * @private - * @type {boolean} - * @memberof BufferScheduler */ private isError: boolean = false; /** * How many handlers are executing. - * - * @private - * @type {number} - * @memberof BufferScheduler */ private executingOutgoingHandlers: number = 0; /** * Encoding of the input Readable stream which has string data type instead of Buffer. - * - * @private - * @type {string} - * @memberof BufferScheduler */ private encoding?: string; /** * How many buffers have been allocated. - * - * @private - * @type {number} - * @memberof BufferScheduler */ private numBuffers: number = 0; @@ -150,37 +100,21 @@ export class BufferScheduler { * data received from the stream, when data in unresolvedDataArray exceeds the * blockSize defined, it will try to concat a blockSize of buffer, fill into available * buffers from incoming and push to outgoing array. - * - * @private - * @type {Buffer[]} - * @memberof BufferScheduler */ private unresolvedDataArray: Buffer[] = []; /** * How much data consisted in unresolvedDataArray. - * - * @private - * @type {number} - * @memberof BufferScheduler */ private unresolvedLength: number = 0; /** * The array includes all the available buffers can be used to fill data from stream. - * - * @private - * @type {Buffer[]} - * @memberof BufferScheduler */ private incoming: Buffer[] = []; /** * The array (queue) includes all the buffers filled from stream data. - * - * @private - * @type {Buffer[]} - * @memberof BufferScheduler */ private outgoing: Buffer[] = []; @@ -193,9 +127,8 @@ export class BufferScheduler { * @param outgoingHandler - An async function scheduled to be * triggered when a buffer fully filled * with stream data - * @param concurrency - Concurrency of executing outgoingHandlers (>0) + * @param concurrency - Concurrency of executing outgoingHandlers (greater than 0) * @param encoding - [Optional] Encoding of Readable stream when it's a string stream - * @memberof BufferScheduler */ constructor( readable: Readable, @@ -229,8 +162,6 @@ export class BufferScheduler { * Start the scheduler, will return error when stream of any of the outgoingHandlers * returns error. * - * - * @memberof BufferScheduler */ public async do(): Promise { return new Promise((resolve, reject) => { @@ -282,9 +213,7 @@ export class BufferScheduler { /** * Insert a new data into unresolved array. * - * @private * @param data - - * @memberof BufferScheduler */ private appendUnresolvedData(data: Buffer) { this.unresolvedDataArray.push(data); @@ -295,9 +224,6 @@ export class BufferScheduler { * Try to shift a buffer with size in blockSize. The buffer returned may be less * than blockSize when data in unresolvedDataArray is less than bufferSize. * - * @private - * - * @memberof BufferScheduler */ private shiftBufferFromUnresolvedDataArray(): Buffer { if (this.unresolvedLength >= this.bufferSize) { @@ -330,9 +256,7 @@ export class BufferScheduler { * * Return false when available buffers in incoming are not enough, else true. * - * @private * @returns Return false when buffers in incoming are not enough, else true. - * @memberof BufferScheduler */ private resolveData(): boolean { while (this.unresolvedLength >= this.bufferSize) { @@ -360,9 +284,6 @@ export class BufferScheduler { /** * Try to trigger a outgoing handler for every buffer in outgoing. Stop when * concurrency reaches. - * - * @private - * @memberof BufferScheduler */ private async triggerOutgoingHandlers() { let buffer: Buffer | undefined; @@ -381,10 +302,7 @@ export class BufferScheduler { /** * Trigger a outgoing handler for a buffer shifted from outgoing. * - * @private * @param buffer - - * - * @memberof BufferScheduler */ private async triggerOutgoingHandler(buffer: Buffer): Promise { const bufferLength = buffer.length; @@ -407,9 +325,7 @@ export class BufferScheduler { /** * Return buffer used by outgoing handler into incoming. * - * @private * @param buffer - - * @memberof BufferScheduler */ private reuseBuffer(buffer: Buffer) { this.incoming.push(buffer); diff --git a/sdk/storage/storage-file-share/src/utils/RetriableReadableStream.ts b/sdk/storage/storage-file-share/src/utils/RetriableReadableStream.ts index 581410759fba..444e9f6bfd38 100644 --- a/sdk/storage/storage-file-share/src/utils/RetriableReadableStream.ts +++ b/sdk/storage/storage-file-share/src/utils/RetriableReadableStream.ts @@ -11,17 +11,12 @@ export type ReadableStreamGetter = (offset: number) => Promise=0), undefined or invalid value means no retry - * - * @type {number} - * @memberof RetriableReadableStreamOptions + * Max retry count (greater than or equal to 0), undefined or invalid value means no retry */ maxRetryRequests?: number; /** * Read progress event handler - * - * @memberof RetriableReadableStreamOptions */ onProgress?: (progress: TransferProgressEvent) => void; @@ -33,9 +28,6 @@ export interface RetriableReadableStreamOptions { * RetriableReadableStream will try to emit an "end" event to existing internal * stream to force it end and start retry from the breaking point. * The value will then update to "undefined", once the injection works. - * - * @type {boolean} - * @memberof RetriableReadableStreamOptions */ doInjectErrorOnce?: boolean; } @@ -46,9 +38,6 @@ const ABORT_ERROR = new AbortError("The operation was aborted."); * ONLY AVAILABLE IN NODE.JS RUNTIME. * * A Node.js ReadableStream will internally retry when internal ReadableStream unexpected ends. - * - * @class RetriableReadableStream - * @extends {Readable} */ export class RetriableReadableStream extends Readable { private aborter: AbortSignalLike; @@ -75,7 +64,6 @@ export class RetriableReadableStream extends Readable { * @param offset - Offset position in original data source to read * @param count - How much data in original data source to read * @param options - - * @memberof RetriableReadableStream */ public constructor( source: NodeJS.ReadableStream, diff --git a/sdk/storage/storage-file-share/src/utils/tracing.ts b/sdk/storage/storage-file-share/src/utils/tracing.ts index add6efde71b7..5f12d9a7d628 100644 --- a/sdk/storage/storage-file-share/src/utils/tracing.ts +++ b/sdk/storage/storage-file-share/src/utils/tracing.ts @@ -6,8 +6,8 @@ import { getTracer, SpanOptions, OperationTracingOptions } from "@azure/core-tra /** * Creates a span using the global tracer. - * @param name The name of the operation being performed. - * @param tracingOptions The tracingOptions for the underlying http request. + * @param name - The name of the operation being performed. + * @param tracingOptions - The tracingOptions for the underlying http request. */ export function createSpan( operationName: string, diff --git a/sdk/storage/storage-file-share/src/utils/utils.browser.ts b/sdk/storage/storage-file-share/src/utils/utils.browser.ts index a1f6449808b0..8b2daa15bfba 100644 --- a/sdk/storage/storage-file-share/src/utils/utils.browser.ts +++ b/sdk/storage/storage-file-share/src/utils/utils.browser.ts @@ -4,9 +4,7 @@ /** * Convert a Browser Blob object into ArrayBuffer. * - * @export * @param blob - - * */ export async function blobToArrayBuffer(blob: Blob): Promise { const fileReader = new FileReader(); diff --git a/sdk/storage/storage-file-share/src/utils/utils.common.ts b/sdk/storage/storage-file-share/src/utils/utils.common.ts index 5eecc6661dba..43fd6505cd16 100644 --- a/sdk/storage/storage-file-share/src/utils/utils.common.ts +++ b/sdk/storage/storage-file-share/src/utils/utils.common.ts @@ -55,9 +55,7 @@ import { HeaderConstants, URLConstants } from "./constants"; * @see https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata * @see https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-shares--directories--files--and-metadata * - * @export * @param url - - * */ export function escapeURLPath(url: string): string { const urlParsed = URLBuilder.parse(url); @@ -101,7 +99,6 @@ function getValueInConnString( /** * Extracts the parts of an Azure Storage account connection string. * - * @export * @param connectionString - Connection string. * @returns String key value pairs of the storage account's url and credentials. */ @@ -176,7 +173,6 @@ export function extractConnectionStringParts(connectionString: string): Connecti * Internal escape method implemented Strategy Two mentioned in escapeURL() description. * * @param text - - * */ function escape(text: string): string { return encodeURIComponent(text) @@ -190,7 +186,6 @@ function escape(text: string): string { * Append a string to URL path. Will remove duplicated "/" in front of the string * when URL path ends with a "/". * - * @export * @param url - Source URL string * @param name - String to be appended to URL * @returns An updated URL string @@ -208,7 +203,6 @@ export function appendToURLPath(url: string, name: string): string { /** * Append a string to URL query. * - * @export * @param url - Source URL string. * @param queryParts - String to be appended to the URL query. * @returns An updated URL string. @@ -231,7 +225,6 @@ export function appendToURLQuery(url: string, queryParts: string): string { * Set URL parameter name and value. If name exists in URL parameters, old value * will be replaced by name key. If not provide value, the parameter will be deleted. * - * @export * @param url - Source URL string * @param name - Parameter name * @param value - Parameter value @@ -246,10 +239,8 @@ export function setURLParameter(url: string, name: string, value?: string): stri /** * Get URL parameter by name. * - * @export * @param url - * @param name - - * */ export function getURLParameter(url: string, name: string): string | string[] | undefined { const urlParsed = URLBuilder.parse(url); @@ -259,7 +250,6 @@ export function getURLParameter(url: string, name: string): string | string[] | /** * Set URL host. * - * @export * @param url - Source URL string * @param host - New host string * @returns An updated URL string @@ -273,9 +263,7 @@ export function setURLHost(url: string, host: string): string { /** * Get URL path from an URL string. * - * @export * @param url - Source URL string - * */ export function getURLPath(url: string): string | undefined { const urlParsed = URLBuilder.parse(url); @@ -285,9 +273,7 @@ export function getURLPath(url: string): string | undefined { /** * Get URL query key value pairs from an URL string. * - * @export * @param url - - * */ export function getURLQueries(url: string): { [key: string]: string } { let queryString = URLBuilder.parse(url).getQuery(); @@ -319,7 +305,6 @@ export function getURLQueries(url: string): { [key: string]: string } { /** * Rounds a date off to seconds. * - * @export * @param date - * @param withMilliseconds - If true, YYYY-MM-DDThh:mm:ss.fffffffZ will be returned; * If false, YYYY-MM-DDThh:mm:ssZ will be returned. @@ -337,9 +322,7 @@ export function truncatedISO8061Date(date: Date, withMilliseconds: boolean = tru /** * Base64 encode. * - * @export * @param content - - * */ export function base64encode(content: string): string { return !isNode ? btoa(content) : Buffer.from(content).toString("base64"); @@ -348,9 +331,7 @@ export function base64encode(content: string): string { /** * Base64 decode. * - * @export * @param encodedString - - * */ export function base64decode(encodedString: string): string { return !isNode ? atob(encodedString) : Buffer.from(encodedString, "base64").toString(); @@ -359,7 +340,6 @@ export function base64decode(encodedString: string): string { /** * Delay specified time interval. * - * @export * @param timeInMs - * @param aborter - * @param abortError - @@ -392,11 +372,9 @@ export async function delay(timeInMs: number, aborter?: AbortSignalLike, abortEr /** * String.prototype.padStart() * - * @export * @param currentString - * @param targetLength - - * @param [padString=" - "] - * + * @param padString - */ export function padStart( currentString: string, diff --git a/sdk/storage/storage-file-share/src/utils/utils.node.ts b/sdk/storage/storage-file-share/src/utils/utils.node.ts index 278bc0b5ec5c..b773afe82221 100644 --- a/sdk/storage/storage-file-share/src/utils/utils.node.ts +++ b/sdk/storage/storage-file-share/src/utils/utils.node.ts @@ -7,13 +7,11 @@ import * as util from "util"; /** * Reads a readable stream into buffer. Fill the buffer from offset to end. * - * @export * @param stream - A Node.js Readable stream - * @param buffer - Buffer to be filled, length must >= offset + * @param buffer - Buffer to be filled, length must greater than or equal to offset * @param offset - From which position in the buffer to be filled, inclusive * @param end - To which position in the buffer to be filled, exclusive * @param encoding - Encoding of the Readable stream - * */ export async function streamToBuffer( stream: NodeJS.ReadableStream, @@ -67,10 +65,8 @@ export async function streamToBuffer( * * Writes the content of a readstream to a local file. Returns a Promise which is completed after the file handle is closed. * - * @export * @param rs - The read stream. * @param file - Destination file path. - * */ export async function readStreamToLocalFile( rs: NodeJS.ReadableStream, diff --git a/sdk/storage/storage-file-share/test/utils/InjectorPolicy.ts b/sdk/storage/storage-file-share/test/utils/InjectorPolicy.ts index f7bc41bec26a..a4a7e192b413 100644 --- a/sdk/storage/storage-file-share/test/utils/InjectorPolicy.ts +++ b/sdk/storage/storage-file-share/test/utils/InjectorPolicy.ts @@ -18,9 +18,6 @@ export type Injector = () => RestError | undefined; /** * InjectorPolicy will inject a customized error before next HTTP request. - * - * @class InjectorPolicy - * @extends {BaseRequestPolicy} */ export class InjectorPolicy extends BaseRequestPolicy { /** @@ -28,7 +25,6 @@ export class InjectorPolicy extends BaseRequestPolicy { * * @param nextPolicy - * @param options - - * @memberof InjectorPolicy */ public constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, injector: Injector) { super(nextPolicy, options); @@ -39,8 +35,6 @@ export class InjectorPolicy extends BaseRequestPolicy { * Sends request. * * @param request - - * - * @memberof InjectorPolicy */ public async sendRequest(request: WebResource): Promise { const error = this.injector(); diff --git a/sdk/storage/storage-file-share/test/utils/InjectorPolicyFactory.ts b/sdk/storage/storage-file-share/test/utils/InjectorPolicyFactory.ts index 09fc932ec95d..b0c36c384558 100644 --- a/sdk/storage/storage-file-share/test/utils/InjectorPolicyFactory.ts +++ b/sdk/storage/storage-file-share/test/utils/InjectorPolicyFactory.ts @@ -6,10 +6,6 @@ import { InjectorPolicy, Injector } from "./InjectorPolicy"; /** * InjectorPolicyFactory is a factory class which injects customized errors for retry policy testing. - * - * @export - * @class InjectorPolicyFactory - * @implements {RequestPolicyFactory} */ export class InjectorPolicyFactory implements RequestPolicyFactory { public readonly injector: Injector; diff --git a/sdk/storage/storage-file-share/test/utils/MockPolicy.ts b/sdk/storage/storage-file-share/test/utils/MockPolicy.ts index cccbfdbc428a..06e5c4473df8 100644 --- a/sdk/storage/storage-file-share/test/utils/MockPolicy.ts +++ b/sdk/storage/storage-file-share/test/utils/MockPolicy.ts @@ -11,9 +11,6 @@ import { /** * Mock - * - * @class MockPolicy - * @extends {BaseRequestPolicy} */ export class MockPolicy extends BaseRequestPolicy { private responseHeaders?: { [key: string]: any }; @@ -22,7 +19,6 @@ export class MockPolicy extends BaseRequestPolicy { * * @param nextPolicy - * @param options - - * @memberof MockPolicy */ public constructor( nextPolicy: RequestPolicy, @@ -37,8 +33,6 @@ export class MockPolicy extends BaseRequestPolicy { * Sends request. * * @param request - - * - * @memberof InjectorPolicy */ public async sendRequest(request: WebResource): Promise { return this._nextPolicy.sendRequest(request).then((res) => { diff --git a/sdk/storage/storage-file-share/test/utils/MockPolicyFactory.ts b/sdk/storage/storage-file-share/test/utils/MockPolicyFactory.ts index c1735140b268..cc6373efee8e 100644 --- a/sdk/storage/storage-file-share/test/utils/MockPolicyFactory.ts +++ b/sdk/storage/storage-file-share/test/utils/MockPolicyFactory.ts @@ -6,10 +6,6 @@ import { MockPolicy } from "./MockPolicy"; /** * MockPolicyFactory is a factory class which tune the response for testing. - * - * @export - * @class MockPolicyFactory - * @implements {RequestPolicyFactory} */ export class MockPolicyFactory implements RequestPolicyFactory { private responseHeaders?: { [key: string]: any }; diff --git a/sdk/storage/storage-file-share/test/utils/index.browser.ts b/sdk/storage/storage-file-share/test/utils/index.browser.ts index 539db8708988..a7a18c04e193 100644 --- a/sdk/storage/storage-file-share/test/utils/index.browser.ts +++ b/sdk/storage/storage-file-share/test/utils/index.browser.ts @@ -54,8 +54,8 @@ export function getSoftDeleteBSU(): ShareServiceClient { * Read body from downloading operation methods to string. * Works in both Node.js and browsers. * - * @param response Convenience layer methods response with downloaded body - * @param length Length of Readable stream, needed for Node.js environment + * @param response - Convenience layer methods response with downloaded body + * @param length - Length of Readable stream, needed for Node.js environment */ export async function bodyToString( response: { @@ -158,8 +158,8 @@ export function arraysEqual(a: Uint8Array, b: Uint8Array): boolean { * Compare the content of body from downloading operation methods with a Uint8Array. * Works in both Node.js and browsers. * - * @param response Convenience layer methods response with downloaded body - * @param uint8arry + * @param response - Convenience layer methods response with downloaded body + * @param uint8arry - */ export async function compareBodyWithUint8Array( response: { diff --git a/sdk/storage/storage-file-share/test/utils/index.ts b/sdk/storage/storage-file-share/test/utils/index.ts index d995c0911481..eeef08ba728c 100644 --- a/sdk/storage/storage-file-share/test/utils/index.ts +++ b/sdk/storage/storage-file-share/test/utils/index.ts @@ -75,8 +75,8 @@ export function getConnectionStringFromEnvironment(): string { * Read body from downloading operation methods to string. * Works in both Node.js and browsers. * - * @param response Convenience layer methods response with downloaded body - * @param length Length of Readable stream, needed for Node.js environment + * @param response - Convenience layer methods response with downloaded body + * @param length - Length of Readable stream, needed for Node.js environment */ export async function bodyToString( response: { @@ -195,7 +195,7 @@ async function streamToBuffer(readableStream: NodeJS.ReadableStream): Promise { const { span, spanOptions } = createSpan("QueueClient-exists", options.tracingOptions); @@ -916,7 +779,6 @@ export class QueueClient extends StorageClient { * * @param options - Options to Queue get properties operation. * @returns Response data for the Queue get properties operation. - * @memberof QueueClient */ public async getProperties( options: QueueGetPropertiesOptions = {} @@ -948,7 +810,6 @@ export class QueueClient extends StorageClient { * @param metadata - If no metadata provided, all existing metadata will be removed. * @param options - Options to Queue set metadata operation. * @returns Response data for the Queue set metadata operation. - * @memberof QueueClient */ public async setMetadata( metadata?: Metadata, @@ -982,7 +843,6 @@ export class QueueClient extends StorageClient { * * @param options - Options to Queue get access policy operation. * @returns Response data for the Queue get access policy operation. - * @memberof QueueClient */ public async getAccessPolicy( options: QueueGetAccessPolicyOptions = {} @@ -1045,7 +905,6 @@ export class QueueClient extends StorageClient { * @param queueAcl - * @param options - Options to Queue set access policy operation. * @returns Response data for the Queue set access policy operation. - * @memberof QueueClient */ public async setAccessPolicy( queueAcl?: SignedIdentifier[], @@ -1091,7 +950,6 @@ export class QueueClient extends StorageClient { * * @param options - Options to clear messages operation. * @returns Response data for the clear messages operation. - * @memberof QueueClient */ public async clearMessages( options: QueueClearMessagesOptions = {} @@ -1123,7 +981,6 @@ export class QueueClient extends StorageClient { * @param messageText - Text of the message to send * @param options - Options to send messages operation. * @returns Response data for the send messages operation. - * @memberof QueueClient * * Example usage: * @@ -1182,7 +1039,6 @@ export class QueueClient extends StorageClient { * * @param options - Options to receive messages operation. * @returns Response data for the receive messages operation. - * @memberof QueueClient * * Example usage: * @@ -1245,7 +1101,6 @@ export class QueueClient extends StorageClient { * * @param options - Options to peek messages operation. * @returns Response data for the peek messages operation. - * @memberof QueueClient * * Example usage: * @@ -1299,7 +1154,6 @@ export class QueueClient extends StorageClient { * @param popReceipt - A valid pop receipt value returned from an earlier call to the receive messages or update message operation. * @param options - Options to delete message operation. * @returns Response data for the delete message operation. - * @memberof QueueClient */ public async deleteMessage( messageId: string, @@ -1339,7 +1193,6 @@ export class QueueClient extends StorageClient { * A message can be updated until it has been deleted or has expired. * @param options - Options to update message operation. * @returns Response data for the update message operation. - * @memberof QueueClient */ public async updateMessage( messageId: string, @@ -1417,7 +1270,6 @@ export class QueueClient extends StorageClient { * * @param options - Optional parameters. * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token. - * @memberof QueueClient */ public generateSasUrl(options: QueueGenerateSasUrlOptions): string { if (!(this.credential instanceof StorageSharedKeyCredential)) { diff --git a/sdk/storage/storage-queue/src/QueueSASPermissions.ts b/sdk/storage/storage-queue/src/QueueSASPermissions.ts index 7f05fe0dd663..64e1e477672d 100644 --- a/sdk/storage/storage-queue/src/QueueSASPermissions.ts +++ b/sdk/storage/storage-queue/src/QueueSASPermissions.ts @@ -9,19 +9,13 @@ * the values are set, this should be serialized with toString and set as the permissions field on a * {@link QueueSASSignatureValues} 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 - * @class QueueSASPermissions */ export class QueueSASPermissions { /** * Creates a {@link QueueSASPermissions} from the specified permissions string. This method will throw an * Error if it encounters a character that does not correspond to a valid permission. * - * @static * @param permissions - - * - * @memberof QueueSASPermissions */ public static parse(permissions: string): QueueSASPermissions { const queueSASPermissions = new QueueSASPermissions(); @@ -50,33 +44,21 @@ export class QueueSASPermissions { /** * Specifies Read access granted. - * - * @type {boolean} - * @memberof QueueSASPermissions */ public read: boolean = false; /** * Specifies Add access granted. - * - * @type {boolean} - * @memberof QueueSASPermissions */ public add: boolean = false; /** * Specifies Update access granted. - * - * @type {boolean} - * @memberof QueueSASPermissions */ public update: boolean = false; /** * Specifies Process access granted. - * - * @type {boolean} - * @memberof QueueSASPermissions */ public process: boolean = false; @@ -85,7 +67,6 @@ export class QueueSASPermissions { * order accepted by the service. * * @returns A string which represents the QueueSASPermissions - * @memberof QueueSASPermissions */ public toString(): string { const permissions: string[] = []; diff --git a/sdk/storage/storage-queue/src/QueueSASSignatureValues.ts b/sdk/storage/storage-queue/src/QueueSASSignatureValues.ts index 1f14162be31f..88c9b6b52402 100644 --- a/sdk/storage/storage-queue/src/QueueSASSignatureValues.ts +++ b/sdk/storage/storage-queue/src/QueueSASSignatureValues.ts @@ -13,41 +13,26 @@ import { truncatedISO8061Date } from "./utils/utils.common"; * ONLY AVAILABLE IN NODE.JS RUNTIME. * * QueueSASSignatureValues is used to help generating Queue service SAS tokens for queues. - * - * @export - * @class QueueSASSignatureValues */ export interface QueueSASSignatureValues { /** * 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 QueueSASSignatureValues */ version?: string; /** * Optional. SAS protocols, HTTPS only or HTTPSandHTTP - * - * @type {SASProtocol} - * @memberof QueueSASSignatureValues */ protocol?: SASProtocol; /** * Optional. When the SAS will take effect. - * - * @type {Date} - * @memberof QueueSASSignatureValues */ startsOn?: Date; /** * Optional only when identifier is provided. The time after which the SAS will no longer work. - * - * @type {Date} - * @memberof QueueSASSignatureValues */ expiresOn?: Date; @@ -55,25 +40,16 @@ export interface QueueSASSignatureValues { * Optional only when identifier is provided. * Please refer to {@link QueueSASPermissions} * being accessed for help constructing the permissions string. - * - * @type {QueueSASPermissions} - * @memberof QueueSASSignatureValues */ permissions?: QueueSASPermissions; /** * Optional. IP ranges allowed in this SAS. - * - * @type {SasIPRange} - * @memberof QueueSASSignatureValues */ ipRange?: SasIPRange; /** * The name of the queue the SAS user may access. - * - * @type {string} - * @memberof QueueSASSignatureValues */ queueName: string; @@ -81,9 +57,6 @@ export interface QueueSASSignatureValues { * Optional. The name of the access policy on the queue this SAS references if any. * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy - * - * @type {string} - * @memberof QueueSASSignatureValues */ identifier?: string; } @@ -100,10 +73,8 @@ export interface QueueSASSignatureValues { * You MUST assign value to identifier or expiresOn & permissions manually if you initial with * this constructor. * - * @export * @param queueSASSignatureValues - * @param sharedKeyCredential - - * */ export function generateQueueSASQueryParameters( queueSASSignatureValues: QueueSASSignatureValues, diff --git a/sdk/storage/storage-queue/src/QueueServiceClient.ts b/sdk/storage/storage-queue/src/QueueServiceClient.ts index 4be23165e80f..418a40a46ba7 100644 --- a/sdk/storage/storage-queue/src/QueueServiceClient.ts +++ b/sdk/storage/storage-queue/src/QueueServiceClient.ts @@ -42,51 +42,33 @@ import { SasIPRange } from "./SasIPRange"; /** * Options to configure {@link QueueServiceClient.getProperties} operation - * - * @export - * @interface ServiceGetPropertiesOptions */ export interface ServiceGetPropertiesOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ServiceGetPropertiesOptions */ abortSignal?: AbortSignalLike; } /** * Options to configure {@link QueueServiceClient.setProperties} operation - * - * @export - * @interface ServiceSetPropertiesOptions */ export interface ServiceSetPropertiesOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ServiceSetPropertiesOptions */ abortSignal?: AbortSignalLike; } /** * Options to configure {@link QueueServiceClient.getStatistics} operation - * - * @export - * @interface ServiceGetStatisticsOptions */ export interface ServiceGetStatisticsOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ServiceGetStatisticsOptions */ abortSignal?: AbortSignalLike; } @@ -98,16 +80,11 @@ export interface ServiceGetStatisticsOptions extends CommonOptions { * - {@link QueueServiceClient.listSegments} * - {@link QueueServiceClient.listQueuesSegment} * - {@link QueueServiceClient.listItems} - * - * @interface ServiceListQueuesSegmentOptions */ interface ServiceListQueuesSegmentOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ServiceListQueuesSegmentOptions */ abortSignal?: AbortSignalLike; /** @@ -135,17 +112,11 @@ interface ServiceListQueuesSegmentOptions extends CommonOptions { /** * Options to configure {@link QueueServiceClient.listQueues} operation - * - * @export - * @interface ServiceListQueuesOptions */ export interface ServiceListQueuesOptions extends CommonOptions { /** * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation. * For example, use the @azure/abort-controller to create an `AbortSignal`. - * - * @type {AbortSignalLike} - * @memberof ServiceListQueuesOptions */ abortSignal?: AbortSignalLike; /** @@ -162,40 +133,25 @@ export interface ServiceListQueuesOptions extends CommonOptions { /** * Options to configure {@link QueueServiceClient.generateAccountSasUrl} operation. - * - * @export - * @interface ServiceGenerateAccountSasUrlOptions */ export interface ServiceGenerateAccountSasUrlOptions { /** * 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 ServiceGenerateAccountSasUrlOptions */ version?: string; /** * Optional. SAS protocols allowed. - * - * @type {SASProtocol} - * @memberof ServiceGenerateAccountSasUrlOptions */ protocol?: SASProtocol; /** * Optional. When the SAS will take effect. - * - * @type {Date} - * @memberof ServiceGenerateAccountSasUrlOptions */ startsOn?: Date; /** * Optional. IP range allowed. - * - * @type {SasIPRange} - * @memberof ServiceGenerateAccountSasUrlOptions */ ipRange?: SasIPRange; } @@ -203,9 +159,6 @@ export interface ServiceGenerateAccountSasUrlOptions { /** * A QueueServiceClient represents a URL to the Azure Storage Queue service allowing you * to manipulate queues. - * - * @export - * @class QueueServiceClient */ export class QueueServiceClient extends StorageClient { /** @@ -219,7 +172,6 @@ export class QueueServiceClient extends StorageClient { * `BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString` * @param options - Options to configure the HTTP pipeline. * @returns A new QueueServiceClient object from the given connection string. - * @memberof QueueServiceClient */ public static fromConnectionString( connectionString: string, @@ -251,10 +203,6 @@ export class QueueServiceClient extends StorageClient { /** * serviceContext provided by protocol layer. - * - * @private - * @type {Service} - * @memberof QueueServiceClient */ private serviceContext: Service; @@ -264,9 +212,8 @@ export class QueueServiceClient extends StorageClient { * @param url - A URL string pointing to Azure Storage queue service, such as * "https://myaccount.queue.core.windows.net". You can append a SAS * if using AnonymousCredential, such as "https://myaccount.queue.core.windows.net?sasString". - * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. + * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used. * @param options - Options to configure the HTTP pipeline. - * @memberof QueueServiceClient * * Example using DefaultAzureCredential from `@azure/identity`: * @@ -311,7 +258,6 @@ export class QueueServiceClient extends StorageClient { * if using AnonymousCredential, such as "https://myaccount.queue.core.windows.net?sasString". * @param pipeline - Call newPipeline() to create a default * pipeline, or provide a customized pipeline. - * @memberof QueueServiceClient */ constructor(url: string, pipeline: Pipeline); constructor( @@ -345,7 +291,6 @@ export class QueueServiceClient extends StorageClient { * * @param queueName - * @returns a new QueueClient - * @memberof QueueServiceClient * * Example usage: * @@ -371,7 +316,6 @@ export class QueueServiceClient extends StorageClient { * items. The marker value is opaque to the client. * @param options - Options to list queues operation. * @returns Response data for the list queues segment operation. - * @memberof QueueServiceClient */ private async listQueuesSegment( marker?: string, @@ -409,7 +353,6 @@ export class QueueServiceClient extends StorageClient { /** * Returns an AsyncIterableIterator for {@link ServiceListQueuesSegmentResponse} objects * - * @private * @param marker - A string value that identifies the portion of * the list of queues to be returned with the next listing operation. The * operation returns the continuationToken value within the response body if the @@ -418,8 +361,6 @@ export class QueueServiceClient extends StorageClient { * the marker parameter in a subsequent call to request the next page of list * items. The marker value is opaque to the client. * @param options - Options to list queues operation. - * - * @memberof QueueServiceClient */ private async *listSegments( marker?: string, @@ -440,10 +381,7 @@ export class QueueServiceClient extends StorageClient { /** * Returns an AsyncIterableIterator for {@link QueueItem} objects * - * @private * @param options - Options to list queues operation. - * - * @memberof QueueServiceClient */ private async *listItems( options: ServiceListQueuesSegmentOptions = {} @@ -535,7 +473,6 @@ export class QueueServiceClient extends StorageClient { * ``` * * @param options - Options to list queues operation. - * @memberof QueueServiceClient * @returns An asyncIterableIterator that supports paging. */ public listQueues( @@ -554,19 +491,19 @@ export class QueueServiceClient extends StorageClient { const iter = this.listItems(updatedOptions); return { /** - * @member {Promise} [next] The next method, part of the iteration protocol + * The next method, part of the iteration protocol */ next() { return iter.next(); }, /** - * @member {Symbol} [asyncIterator] The connection to the async iterator, part of the iteration protocol + * The connection to the async iterator, part of the iteration protocol */ [Symbol.asyncIterator]() { return this; }, /** - * @member {Function} [byPage] Return an AsyncIterableIterator that works a page at a time + * Return an AsyncIterableIterator that works a page at a time */ byPage: (settings: PageSettings = {}) => { return this.listSegments(settings.continuationToken, { @@ -584,7 +521,6 @@ export class QueueServiceClient extends StorageClient { * * @param options - Options to get properties operation. * @returns Response data including the queue service properties. - * @memberof QueueServiceClient */ public async getProperties( options: ServiceGetPropertiesOptions = {} @@ -617,7 +553,6 @@ export class QueueServiceClient extends StorageClient { * @param properties - * @param options - Options to set properties operation. * @returns Response data for the Set Properties operation. - * @memberof QueueServiceClient */ public async setProperties( properties: QueueServiceProperties, @@ -651,7 +586,6 @@ export class QueueServiceClient extends StorageClient { * * @param options - Options to get statistics operation. * @returns Response data for get statistics the operation. - * @memberof QueueServiceClient */ public async getStatistics( options: ServiceGetStatisticsOptions = {} @@ -683,7 +617,6 @@ export class QueueServiceClient extends StorageClient { * @param queueName - name of the queue to create * @param options - Options to Queue create operation. * @returns Response data for the Queue create operation. - * @memberof QueueServiceClient */ public async createQueue( queueName: string, @@ -716,7 +649,6 @@ export class QueueServiceClient extends StorageClient { * @param queueName - name of the queue to delete. * @param options - Options to Queue delete operation. * @returns Response data for the Queue delete operation. - * @memberof QueueServiceClient */ public async deleteQueue( queueName: string, @@ -755,7 +687,6 @@ export class QueueServiceClient extends StorageClient { * @param resourceTypes - Specifies the resource types associated with the shared access signature. * @param options - Optional parameters. * @returns An account SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token. - * @memberof QueueServiceClient */ public generateAccountSasUrl( expiresOn?: Date, diff --git a/sdk/storage/storage-queue/src/SASQueryParameters.ts b/sdk/storage/storage-queue/src/SASQueryParameters.ts index bbc06cb3d4be..9ce0b986d013 100644 --- a/sdk/storage/storage-queue/src/SASQueryParameters.ts +++ b/sdk/storage/storage-queue/src/SASQueryParameters.ts @@ -6,9 +6,6 @@ import { truncatedISO8061Date } from "./utils/utils.common"; /** * Protocols for generated SAS. - * - * @export - * @enum {string} */ export enum SASProtocol { /** @@ -30,67 +27,43 @@ export enum SASProtocol { * these query parameters). * * NOTE: Instances of this class are immutable. - * - * @export - * @class SASQueryParameters */ export class SASQueryParameters { /** * The storage API version. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly version: string; /** * Optional. The allowed HTTP protocol(s). - * - * @type {SASProtocol} - * @memberof SASQueryParameters */ public readonly protocol?: SASProtocol; /** * Optional. The start time for this SAS token. - * - * @type {Date} - * @memberof SASQueryParameters */ public readonly startsOn?: Date; /** * Optional only when identifier is provided. The expiry time for this SAS token. - * - * @type {Date} - * @memberof SASQueryParameters */ public readonly expiresOn?: Date; /** * Optional only when identifier is provided. * Please refer to {@link AccountSASPermissions}, {@link QueueSASPermissions} for more details. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly permissions?: string; /** * Optional. The storage services being accessed (only for Account SAS). Please refer to {@link AccountSASServices} * for more details. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly services?: string; /** * Optional. The storage resource types being accessed (only for Account SAS). Please refer to * {@link AccountSASResourceTypes} for more details. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly resourceTypes?: string; @@ -98,34 +71,21 @@ export class SASQueryParameters { * Optional. The signed identifier (only for {@link QueueSASSignatureValues}). * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy - * - * @type {string} - * @memberof SASQueryParameters */ public readonly identifier?: string; /** * Optional. The storage queue (only for {@link QueueSASSignatureValues}). - * - * @type {string} - * @memberof SASQueryParameters */ public readonly resource?: string; /** * The signature for the SAS token. - * - * @type {string} - * @memberof SASQueryParameters */ public readonly signature: string; /** * Inner value of getter ipRange. - * - * @private - * @type {SasIPRange} - * @memberof SASQueryParameters */ private readonly ipRangeInner?: SasIPRange; @@ -133,8 +93,6 @@ export class SASQueryParameters { * Optional. IP range allowed for this SAS. * * @readonly - * @type {(SasIPRange | undefined)} - * @memberof SASQueryParameters */ public get ipRange(): SasIPRange | undefined { if (this.ipRangeInner) { @@ -190,8 +148,6 @@ export class SASQueryParameters { /** * Encodes all SAS query parameters into a string that can be appended to a URL. * - * - * @memberof SASQueryParameters */ public toString(): string { const params: string[] = ["sv", "ss", "srt", "spr", "st", "se", "sip", "si", "sr", "sp", "sig"]; @@ -252,12 +208,9 @@ export class SASQueryParameters { /** * A private helper method used to filter and append query key/value pairs into an array. * - * @private * @param queries - * @param key - * @param value - - * - * @memberof SASQueryParameters */ private tryAppendQueryParameter(queries: string[], key: string, value?: string): void { if (!value) { diff --git a/sdk/storage/storage-queue/src/SasIPRange.ts b/sdk/storage/storage-queue/src/SasIPRange.ts index 08932c50e16b..516894476648 100644 --- a/sdk/storage/storage-queue/src/SasIPRange.ts +++ b/sdk/storage/storage-queue/src/SasIPRange.ts @@ -3,25 +3,16 @@ /** * Allowed IP range for a SAS. - * - * @export - * @interface SasIPRange */ export interface SasIPRange { /** * Starting IP address in the IP range. * If end IP doesn't provide, start IP will the only IP allowed. - * - * @type {string} - * @memberof SasIPRange */ start: string; /** * Optional. IP address that ends the IP range. * If not provided, start IP will the only IP allowed. - * - * @type {string} - * @memberof SasIPRange */ end?: string; } @@ -31,9 +22,7 @@ export interface SasIPRange { * * "8.8.8.8" or "1.1.1.1-255.255.255.255" * - * @export * @param ipRange - - * */ export function ipRangeToString(ipRange: SasIPRange): string { return ipRange.end ? `${ipRange.start}-${ipRange.end}` : ipRange.start; diff --git a/sdk/storage/storage-queue/src/StorageBrowserPolicyFactory.ts b/sdk/storage/storage-queue/src/StorageBrowserPolicyFactory.ts index 4afde19ad4d2..a22f4bfeb647 100644 --- a/sdk/storage/storage-queue/src/StorageBrowserPolicyFactory.ts +++ b/sdk/storage/storage-queue/src/StorageBrowserPolicyFactory.ts @@ -7,10 +7,6 @@ export { StorageBrowserPolicy }; /** * StorageBrowserPolicyFactory is a factory class helping generating {@link StorageBrowserPolicy} objects. - * - * @export - * @class StorageBrowserPolicyFactory - * @implements {RequestPolicyFactory} */ export class StorageBrowserPolicyFactory implements RequestPolicyFactory { /** @@ -18,8 +14,6 @@ export class StorageBrowserPolicyFactory implements RequestPolicyFactory { * * @param nextPolicy - * @param options - - * - * @memberof StorageBrowserPolicyFactory */ public create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageBrowserPolicy { return new StorageBrowserPolicy(nextPolicy, options); diff --git a/sdk/storage/storage-queue/src/StorageClient.ts b/sdk/storage/storage-queue/src/StorageClient.ts index 062759551c26..e716eebd151d 100644 --- a/sdk/storage/storage-queue/src/StorageClient.ts +++ b/sdk/storage/storage-queue/src/StorageClient.ts @@ -22,16 +22,10 @@ export interface CommonOptions { /** * A StorageClient represents a based client class for {@link QueueServiceClient}, {@link QueueClient} and etc. - * - * @export - * @class StorageClient */ export abstract class StorageClient { /** * URL string value. - * - * @type {string} - * @memberof StorageClient */ public readonly url: string; public readonly accountName: string; @@ -40,9 +34,6 @@ export abstract class StorageClient { * Request policy pipeline. * * @internal - * @hidden - * @type {Pipeline} - * @memberof StorageClient */ protected readonly pipeline: Pipeline; @@ -51,19 +42,12 @@ export abstract class StorageClient { * Initialized to an AnonymousCredential if not able to retrieve it from the pipeline. * * @internal - * @hidden - * @type {Credential} - * @memberof StorageClient */ protected readonly credential: Credential; /** * StorageClientContext is a reference to protocol layer operations entry, which is * generated by AutoRest generator. - * - * @protected - * @type {StorageClientContext} - * @memberof StorageClient */ protected readonly storageClientContext: StorageClientContext; @@ -71,7 +55,6 @@ export abstract class StorageClient { * Creates an instance of StorageClient. * @param url - * @param pipeline - - * @memberof StorageClient */ protected constructor(url: string, pipeline: Pipeline) { this.url = url; diff --git a/sdk/storage/storage-queue/src/StorageRetryPolicyFactory.ts b/sdk/storage/storage-queue/src/StorageRetryPolicyFactory.ts index 8f2bf7e3c363..0353192855c2 100644 --- a/sdk/storage/storage-queue/src/StorageRetryPolicyFactory.ts +++ b/sdk/storage/storage-queue/src/StorageRetryPolicyFactory.ts @@ -8,16 +8,10 @@ export { StorageRetryPolicyType, StorageRetryPolicy }; /** * Storage Queue retry options interface. - * - * @export - * @interface StorageRetryOptions */ export interface StorageRetryOptions { /** * Optional. StorageRetryPolicyType, default is exponential retry policy. - * - * @type {StorageRetryPolicyType} - * @memberof StorageRetryOptions */ readonly retryPolicyType?: StorageRetryPolicyType; @@ -25,9 +19,6 @@ export interface StorageRetryOptions { * Optional. Max try number of attempts, default is 4. * A value of 1 means 1 try and no retries. * A value smaller than 1 means default retry number of attempts. - * - * @type {number} - * @memberof StorageRetryOptions */ readonly maxTries?: number; @@ -36,9 +27,6 @@ export interface StorageRetryOptions { * A value of zero or undefined means that you accept our default timeout, 30s or 30 * 1000ms. * * @see https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations - * - * @type {number} - * @memberof StorageRetryOptions */ readonly tryTimeoutInMs?: number; @@ -46,18 +34,12 @@ export interface StorageRetryOptions { * Optional. Specifies the amount of delay to use before retrying an operation (default is 4s or 4 * 1000ms). * The delay increases (exponentially or linearly) with each retry up to a maximum specified by * maxRetryDelayInMs. If you specify 0, then you must also specify 0 for maxRetryDelayInMs. - * - * @type {number} - * @memberof StorageRetryOptions */ readonly retryDelayInMs?: number; /** * Optional. Specifies the maximum delay allowed before retrying an operation (default is 120s or 120 * 1000ms). * If you specify 0, then you must also specify 0 for retryDelayInMs. - * - * @type {number} - * @memberof StorageRetryOptions */ readonly maxRetryDelayInMs?: number; @@ -68,19 +50,12 @@ export interface StorageRetryOptions { * NOTE: Before setting this field, make sure you understand the issues around * reading stale and potentially-inconsistent data at * {@link https://docs.microsoft.com/en-us/azure/storage/common/storage-designing-ha-apps-with-ragrs} - * - * @type {string} - * @memberof StorageRetryOptions */ readonly secondaryHost?: string; } /** * StorageRetryPolicyFactory is a factory class helping generating {@link StorageRetryPolicy} objects. - * - * @export - * @class StorageRetryPolicyFactory - * @implements {RequestPolicyFactory} */ export class StorageRetryPolicyFactory implements RequestPolicyFactory { private retryOptions?: StorageRetryOptions; @@ -88,7 +63,6 @@ export class StorageRetryPolicyFactory implements RequestPolicyFactory { /** * Creates an instance of StorageRetryPolicyFactory. * @param retryOptions - - * @memberof StorageRetryPolicyFactory */ constructor(retryOptions?: StorageRetryOptions) { this.retryOptions = retryOptions; @@ -99,8 +73,6 @@ export class StorageRetryPolicyFactory implements RequestPolicyFactory { * * @param nextPolicy - * @param options - - * - * @memberof StorageRetryPolicyFactory */ public create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageRetryPolicy { return new StorageRetryPolicy(nextPolicy, options, this.retryOptions); diff --git a/sdk/storage/storage-queue/src/TelemetryPolicyFactory.ts b/sdk/storage/storage-queue/src/TelemetryPolicyFactory.ts index 385343a3bdf7..05cf570894c0 100644 --- a/sdk/storage/storage-queue/src/TelemetryPolicyFactory.ts +++ b/sdk/storage/storage-queue/src/TelemetryPolicyFactory.ts @@ -15,22 +15,16 @@ import { SDK_VERSION } from "./utils/constants"; /** * TelemetryPolicyFactory is a factory class helping generating {@link TelemetryPolicy} objects. - * - * @export - * @class TelemetryPolicyFactory - * @implements {RequestPolicyFactory} */ export class TelemetryPolicyFactory implements RequestPolicyFactory { /** * @internal - * @hidden */ public readonly telemetryString: string; /** * Creates an instance of TelemetryPolicyFactory. * @param telemetry - - * @memberof TelemetryPolicyFactory */ constructor(telemetry?: UserAgentOptions) { const userAgentInfo: string[] = []; @@ -64,8 +58,6 @@ export class TelemetryPolicyFactory implements RequestPolicyFactory { * * @param nextPolicy - * @param options - - * - * @memberof TelemetryPolicyFactory */ public create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): TelemetryPolicy { return new TelemetryPolicy(nextPolicy, options, this.telemetryString); diff --git a/sdk/storage/storage-queue/src/credentials/AnonymousCredential.ts b/sdk/storage/storage-queue/src/credentials/AnonymousCredential.ts index 007295d2e8c5..9717ff854a8f 100644 --- a/sdk/storage/storage-queue/src/credentials/AnonymousCredential.ts +++ b/sdk/storage/storage-queue/src/credentials/AnonymousCredential.ts @@ -11,10 +11,6 @@ import { Credential } from "./Credential"; * {@link AnonymousCredentialPolicy} objects. {@link AnonymousCredentialPolicy} is used with * HTTP(S) requests that read public resources or for use with Shared Access * Signatures (SAS). - * - * @export - * @class AnonymousCredential - * @extends {Credential} */ export class AnonymousCredential extends Credential { /** @@ -22,8 +18,6 @@ export class AnonymousCredential extends Credential { * * @param nextPolicy - * @param options - - * - * @memberof AnonymousCredential */ public create( nextPolicy: RequestPolicy, diff --git a/sdk/storage/storage-queue/src/credentials/Credential.ts b/sdk/storage/storage-queue/src/credentials/Credential.ts index 8cc556d37638..ec1bee135c2c 100644 --- a/sdk/storage/storage-queue/src/credentials/Credential.ts +++ b/sdk/storage/storage-queue/src/credentials/Credential.ts @@ -7,10 +7,6 @@ import { CredentialPolicy } from "../policies/CredentialPolicy"; /** * Credential is an abstract class for Azure Storage HTTP requests signing. This * class will host an credentialPolicyCreator factory which generates CredentialPolicy. - * - * @export - * @abstract - * @class Credential */ export abstract class Credential implements RequestPolicyFactory { /** @@ -18,8 +14,6 @@ export abstract class Credential implements RequestPolicyFactory { * * @param _nextPolicy - * @param _options - - * - * @memberof Credential */ public create( // tslint:disable-next-line:variable-name diff --git a/sdk/storage/storage-queue/src/credentials/StorageSharedKeyCredential.ts b/sdk/storage/storage-queue/src/credentials/StorageSharedKeyCredential.ts index eab8c80a9763..0b047c493e0b 100644 --- a/sdk/storage/storage-queue/src/credentials/StorageSharedKeyCredential.ts +++ b/sdk/storage/storage-queue/src/credentials/StorageSharedKeyCredential.ts @@ -11,25 +11,15 @@ import { Credential } from "./Credential"; * ONLY AVAILABLE IN NODE.JS RUNTIME. * * StorageSharedKeyCredential for account key authorization of Azure Storage service. - * - * @export - * @class StorageSharedKeyCredential - * @extends {Credential} */ export class StorageSharedKeyCredential extends Credential { /** * Azure Storage account name; readonly. - * - * @type {string} - * @memberof StorageSharedKeyCredential */ public readonly accountName: string; /** * Azure Storage account key; readonly. - * - * @type {Buffer} - * @memberof StorageSharedKeyCredential */ private readonly accountKey: Buffer; @@ -37,7 +27,6 @@ export class StorageSharedKeyCredential extends Credential { * Creates an instance of StorageSharedKeyCredential. * @param accountName - * @param accountKey - - * @memberof StorageSharedKeyCredential */ constructor(accountName: string, accountKey: string) { super(); @@ -50,8 +39,6 @@ export class StorageSharedKeyCredential extends Credential { * * @param nextPolicy - * @param options - - * - * @memberof StorageSharedKeyCredential */ public create( nextPolicy: RequestPolicy, @@ -64,8 +51,6 @@ export class StorageSharedKeyCredential extends Credential { * Generates a hash signature for an HTTP request or for a SAS. * * @param stringToSign - - * - * @memberof StorageSharedKeyCredential */ public computeHMACSHA256(stringToSign: string): string { return createHmac("sha256", this.accountKey) diff --git a/sdk/storage/storage-queue/src/log.ts b/sdk/storage/storage-queue/src/log.ts index 6f1784dc851b..f87f20e791e2 100644 --- a/sdk/storage/storage-queue/src/log.ts +++ b/sdk/storage/storage-queue/src/log.ts @@ -4,6 +4,6 @@ import { createClientLogger } from "@azure/logger"; /** - * The @azure/logger configuration for this package. + * The `@azure/logger` configuration for this package. */ export const logger = createClientLogger("storage-queue"); diff --git a/sdk/storage/storage-queue/src/policies/AnonymousCredentialPolicy.ts b/sdk/storage/storage-queue/src/policies/AnonymousCredentialPolicy.ts index 743528139e91..08e4118ad4c0 100644 --- a/sdk/storage/storage-queue/src/policies/AnonymousCredentialPolicy.ts +++ b/sdk/storage/storage-queue/src/policies/AnonymousCredentialPolicy.ts @@ -8,17 +8,12 @@ import { CredentialPolicy } from "./CredentialPolicy"; /** * AnonymousCredentialPolicy is used with HTTP(S) requests that read public resources * or for use with Shared Access Signatures (SAS). - * - * @export - * @class AnonymousCredentialPolicy - * @extends {CredentialPolicy} */ export class AnonymousCredentialPolicy extends CredentialPolicy { /** * Creates an instance of AnonymousCredentialPolicy. * @param nextPolicy - * @param options - - * @memberof AnonymousCredentialPolicy */ constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions) { super(nextPolicy, options); diff --git a/sdk/storage/storage-queue/src/policies/CredentialPolicy.ts b/sdk/storage/storage-queue/src/policies/CredentialPolicy.ts index e8796c296e71..a0866f5705f3 100644 --- a/sdk/storage/storage-queue/src/policies/CredentialPolicy.ts +++ b/sdk/storage/storage-queue/src/policies/CredentialPolicy.ts @@ -6,19 +6,12 @@ import { BaseRequestPolicy, HttpOperationResponse, WebResource } from "@azure/co /** * Credential policy used to sign HTTP(S) requests before sending. This is an * abstract class. - * - * @export - * @abstract - * @class CredentialPolicy - * @extends {BaseRequestPolicy} */ export abstract class CredentialPolicy extends BaseRequestPolicy { /** * Sends out request. * * @param request - - * - * @memberof CredentialPolicy */ public sendRequest(request: WebResource): Promise { return this._nextPolicy.sendRequest(this.signRequest(request)); @@ -28,11 +21,7 @@ export abstract class CredentialPolicy extends BaseRequestPolicy { * Child classes must implement this method with request signing. This method * will be executed in {@link sendRequest}. * - * @protected - * @abstract * @param request - - * - * @memberof CredentialPolicy */ protected signRequest(request: WebResource): WebResource { // Child classes must override this method with request signing. This method diff --git a/sdk/storage/storage-queue/src/policies/StorageBrowserPolicy.ts b/sdk/storage/storage-queue/src/policies/StorageBrowserPolicy.ts index 5e26f9d13903..35748194822e 100644 --- a/sdk/storage/storage-queue/src/policies/StorageBrowserPolicy.ts +++ b/sdk/storage/storage-queue/src/policies/StorageBrowserPolicy.ts @@ -23,16 +23,12 @@ import { setURLParameter } from "../utils/utils.common"; * 2. Remove cookie header for security * * 3. Remove content-length header to avoid browsers warning - * - * @class StorageBrowserPolicy - * @extends {BaseRequestPolicy} */ export class StorageBrowserPolicy extends BaseRequestPolicy { /** * Creates an instance of StorageBrowserPolicy. * @param nextPolicy - * @param options - - * @memberof StorageBrowserPolicy */ constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions) { super(nextPolicy, options); @@ -42,8 +38,6 @@ export class StorageBrowserPolicy extends BaseRequestPolicy { * Sends out request. * * @param request - - * - * @memberof StorageBrowserPolicy */ public async sendRequest(request: WebResource): Promise { if (isNode) { diff --git a/sdk/storage/storage-queue/src/policies/StorageRetryPolicy.ts b/sdk/storage/storage-queue/src/policies/StorageRetryPolicy.ts index 5679bd930680..57881fe7821b 100644 --- a/sdk/storage/storage-queue/src/policies/StorageRetryPolicy.ts +++ b/sdk/storage/storage-queue/src/policies/StorageRetryPolicy.ts @@ -22,9 +22,7 @@ import { logger } from "../log"; /** * A factory method used to generated a RetryPolicy factory. * - * @export * @param retryOptions - - * */ export function NewRetryPolicyFactory(retryOptions?: StorageRetryOptions): RequestPolicyFactory { return { @@ -36,9 +34,6 @@ export function NewRetryPolicyFactory(retryOptions?: StorageRetryOptions): Reque /** * RetryPolicy types. - * - * @export - * @enum {number} */ export enum StorageRetryPolicyType { /** @@ -65,17 +60,10 @@ const RETRY_ABORT_ERROR = new AbortError("The operation was aborted."); /** * Retry policy with exponential retry and linear retry implemented. - * - * @class RetryPolicy - * @extends {BaseRequestPolicy} */ export class StorageRetryPolicy extends BaseRequestPolicy { /** * RetryOptions. - * - * @private - * @type {RetryOptions} - * @memberof StorageRetryPolicy */ private readonly retryOptions: StorageRetryOptions; @@ -85,7 +73,6 @@ export class StorageRetryPolicy extends BaseRequestPolicy { * @param nextPolicy - * @param options - * @param retryOptions - - * @memberof StorageRetryPolicy */ constructor( nextPolicy: RequestPolicy, @@ -135,8 +122,6 @@ export class StorageRetryPolicy extends BaseRequestPolicy { * Sends request. * * @param request - - * - * @memberof StorageRetryPolicy */ public async sendRequest(request: WebResource): Promise { return this.attemptSendRequest(request, false, 1); @@ -145,7 +130,6 @@ export class StorageRetryPolicy extends BaseRequestPolicy { /** * Decide and perform next retry. Won't mutate request parameter. * - * @protected * @param request - * @param response - * @param secondaryHas404 - If attempt was against the secondary & it returned a StatusNotFound (404), then @@ -153,8 +137,6 @@ export class StorageRetryPolicy extends BaseRequestPolicy { * case, we'll never try the secondary again for this operation. * @param attempt - How many retries has been attempted to performed, starting from 1, which includes * the attempt will be performed by this method call. - * - * @memberof StorageRetryPolicy */ protected async attemptSendRequest( request: WebResource, @@ -203,13 +185,10 @@ export class StorageRetryPolicy extends BaseRequestPolicy { /** * Decide whether to retry according to last HTTP response and retry counters. * - * @protected * @param isPrimaryRetry - * @param attempt - * @param response - * @param err - - * - * @memberof StorageRetryPolicy */ protected shouldRetry( isPrimaryRetry: boolean, @@ -281,11 +260,9 @@ export class StorageRetryPolicy extends BaseRequestPolicy { /** * Delay a calculated time between retries. * - * @private * @param isPrimaryRetry - * @param attempt - * @param abortSignal - - * @memberof StorageRetryPolicy */ private async delay(isPrimaryRetry: boolean, attempt: number, abortSignal?: AbortSignalLike) { let delayTimeInMs: number = 0; diff --git a/sdk/storage/storage-queue/src/policies/StorageSharedKeyCredentialPolicy.ts b/sdk/storage/storage-queue/src/policies/StorageSharedKeyCredentialPolicy.ts index d881b248eb0f..041f8abd2252 100644 --- a/sdk/storage/storage-queue/src/policies/StorageSharedKeyCredentialPolicy.ts +++ b/sdk/storage/storage-queue/src/policies/StorageSharedKeyCredentialPolicy.ts @@ -9,17 +9,10 @@ import { CredentialPolicy } from "./CredentialPolicy"; /** * StorageSharedKeyCredentialPolicy is a policy used to sign HTTP request with a shared key. - * - * @export - * @class StorageSharedKeyCredentialPolicy - * @extends {CredentialPolicy} */ export class StorageSharedKeyCredentialPolicy extends CredentialPolicy { /** * Reference to {@link StorageSharedKeyCredential} which generates StorageSharedKeyCredentialPolicy - * - * @type {StorageSharedKeyCredential} - * @memberof StorageSharedKeyCredentialPolicy */ private readonly factory: StorageSharedKeyCredential; @@ -28,7 +21,6 @@ export class StorageSharedKeyCredentialPolicy extends CredentialPolicy { * @param nextPolicy - * @param options - * @param factory - - * @memberof StorageSharedKeyCredentialPolicy */ constructor( nextPolicy: RequestPolicy, @@ -42,10 +34,7 @@ export class StorageSharedKeyCredentialPolicy extends CredentialPolicy { /** * Signs request. * - * @protected * @param request - - * - * @memberof StorageSharedKeyCredentialPolicy */ protected signRequest(request: WebResource): WebResource { request.headers.set(HeaderConstants.X_MS_DATE, new Date().toUTCString()); @@ -90,11 +79,8 @@ export class StorageSharedKeyCredentialPolicy extends CredentialPolicy { * Retrieve header value according to shared key sign rules. * @see https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key * - * @private * @param request - * @param headerName - - * - * @memberof StorageSharedKeyCredentialPolicy */ private getHeaderValueToSign(request: WebResource, headerName: string): string { const value = request.headers.get(headerName); @@ -124,10 +110,7 @@ export class StorageSharedKeyCredentialPolicy extends CredentialPolicy { * 6. Finally, append a new-line character to each canonicalized header in the resulting list. * Construct the CanonicalizedHeaders string by concatenating all headers in this list into a single string. * - * @private * @param request - - * - * @memberof StorageSharedKeyCredentialPolicy */ private getCanonicalizedHeadersString(request: WebResource): string { let headersArray = request.headers.headersArray().filter((value) => { @@ -159,10 +142,7 @@ export class StorageSharedKeyCredentialPolicy extends CredentialPolicy { /** * Retrieves the webResource canonicalized resource string. * - * @private * @param request - - * - * @memberof StorageSharedKeyCredentialPolicy */ private getCanonicalizedResourceString(request: WebResource): string { const path = encodeURI(getURLPath(request.url) || "/"); diff --git a/sdk/storage/storage-queue/src/policies/TelemetryPolicy.ts b/sdk/storage/storage-queue/src/policies/TelemetryPolicy.ts index 519397076b4e..8ec37fecc2c7 100644 --- a/sdk/storage/storage-queue/src/policies/TelemetryPolicy.ts +++ b/sdk/storage/storage-queue/src/policies/TelemetryPolicy.ts @@ -15,16 +15,10 @@ import { HeaderConstants } from "../utils/constants"; /** * TelemetryPolicy is a policy used to tag user-agent header for every requests. - * - * @class TelemetryPolicy - * @extends {BaseRequestPolicy} */ export class TelemetryPolicy extends BaseRequestPolicy { /** * Telemetry string. - * - * @type {string} - * @memberof TelemetryPolicy */ public readonly telemetry: string; @@ -33,7 +27,6 @@ export class TelemetryPolicy extends BaseRequestPolicy { * @param nextPolicy - * @param options - * @param telemetry - - * @memberof TelemetryPolicy */ constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, telemetry: string) { super(nextPolicy, options); @@ -44,8 +37,6 @@ export class TelemetryPolicy extends BaseRequestPolicy { * Sends out request. * * @param request - - * - * @memberof TelemetryPolicy */ public async sendRequest(request: WebResource): Promise { if (isNode) { diff --git a/sdk/storage/storage-queue/src/utils/utils.common.ts b/sdk/storage/storage-queue/src/utils/utils.common.ts index 9adb3782bc8d..fa8d0f939177 100644 --- a/sdk/storage/storage-queue/src/utils/utils.common.ts +++ b/sdk/storage/storage-queue/src/utils/utils.common.ts @@ -10,7 +10,6 @@ import { Pipeline } from "../Pipeline"; * Append a string to URL path. Will remove duplicated "/" in front of the string * when URL path ends with a "/". * - * @export * @param url - Source URL string * @param name - String to be appended to URL * @returns An updated URL string @@ -29,7 +28,6 @@ export function appendToURLPath(url: string, name: string): string { * Set URL parameter name and value. If name exists in URL parameters, old value * will be replaced by name key. If not provide value, the parameter will be deleted. * - * @export * @param url - Source URL string * @param name - Parameter name * @param value - Parameter value @@ -44,7 +42,6 @@ export function setURLParameter(url: string, name: string, value?: string): stri /** * Get URL parameter by name. * - * @export * @param url - URL string * @param name - Parameter name * @returns Parameter value(s) for the given parameter name. @@ -57,7 +54,6 @@ export function getURLParameter(url: string, name: string): string | string[] | /** * Set URL host. * - * @export * @param url - Source URL string * @param host - New host string * @returns An updated URL string @@ -71,7 +67,6 @@ export function setURLHost(url: string, host: string): string { /** * Gets URL path from an URL string. * - * @export * @param url - Source URL string * @returns The path part of the given URL string. */ @@ -83,7 +78,6 @@ export function getURLPath(url: string): string | undefined { /** * Gets URL query key value pairs from an URL string. * - * @export * @param url - * @returns query key value string pairs from the given URL string. */ @@ -169,7 +163,6 @@ export function getValueInConnString( /** * Extracts the parts of an Azure Storage account connection string. * - * @export * @param connectionString - Connection string. * @returns String key value pairs of the storage account's url and credentials. */ @@ -253,7 +246,6 @@ export function extractConnectionStringParts(connectionString: string): Connecti /** * Rounds a date off to seconds. * - * @export * @param date - * @param withMilliseconds - If true, YYYY-MM-DDThh:mm:ss.fffffffZ will be returned; * If false, YYYY-MM-DDThh:mm:ssZ will be returned. @@ -271,7 +263,6 @@ export function truncatedISO8061Date(date: Date, withMilliseconds: boolean = tru /** * Delay specified time interval. * - * @export * @param timeInMs - * @param aborter - * @param abortError - @@ -304,11 +295,9 @@ export async function delay(timeInMs: number, aborter?: AbortSignalLike, abortEr /** * String.prototype.padStart() * - * @export * @param currentString - * @param targetLength - - * @param [padString=" - "] - * + * @param padString - */ export function padStart( currentString: string, @@ -428,7 +417,6 @@ export function getStorageClientContext(url: string, pipeline: Pipeline): Storag /** * Append a string to URL query. * - * @export * @param url - Source URL string. * @param queryParts - String to be appended to the URL query. * @returns An updated URL string. diff --git a/sdk/storage/storage-queue/test/utils/InjectorPolicy.ts b/sdk/storage/storage-queue/test/utils/InjectorPolicy.ts index f7bc41bec26a..a4a7e192b413 100644 --- a/sdk/storage/storage-queue/test/utils/InjectorPolicy.ts +++ b/sdk/storage/storage-queue/test/utils/InjectorPolicy.ts @@ -18,9 +18,6 @@ export type Injector = () => RestError | undefined; /** * InjectorPolicy will inject a customized error before next HTTP request. - * - * @class InjectorPolicy - * @extends {BaseRequestPolicy} */ export class InjectorPolicy extends BaseRequestPolicy { /** @@ -28,7 +25,6 @@ export class InjectorPolicy extends BaseRequestPolicy { * * @param nextPolicy - * @param options - - * @memberof InjectorPolicy */ public constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, injector: Injector) { super(nextPolicy, options); @@ -39,8 +35,6 @@ export class InjectorPolicy extends BaseRequestPolicy { * Sends request. * * @param request - - * - * @memberof InjectorPolicy */ public async sendRequest(request: WebResource): Promise { const error = this.injector(); diff --git a/sdk/storage/storage-queue/test/utils/InjectorPolicyFactory.ts b/sdk/storage/storage-queue/test/utils/InjectorPolicyFactory.ts index f592e9d94a37..c073e7bbf193 100644 --- a/sdk/storage/storage-queue/test/utils/InjectorPolicyFactory.ts +++ b/sdk/storage/storage-queue/test/utils/InjectorPolicyFactory.ts @@ -6,10 +6,6 @@ import { InjectorPolicy, Injector } from "./InjectorPolicy"; /** * InjectorPolicyFactory is a factory class injects customized errors for retry policy testing. - * - * @export - * @class InjectorPolicyFactory - * @implements {RequestPolicyFactory} */ export class InjectorPolicyFactory implements RequestPolicyFactory { public readonly injector: Injector; diff --git a/sdk/storage/storage-queue/test/utils/index.browser.ts b/sdk/storage/storage-queue/test/utils/index.browser.ts index d1c5512d880f..04124ea45b5e 100644 --- a/sdk/storage/storage-queue/test/utils/index.browser.ts +++ b/sdk/storage/storage-queue/test/utils/index.browser.ts @@ -49,8 +49,8 @@ export function getAlternateQSU(): QueueServiceClient { * Read body from downloading operation methods to string. * Works in both Node.js and browsers. * - * @param response Convenience layer methods response with downloaded body - * @param length Length of Readable stream, needed for Node.js environment + * @param response - Convenience layer methods response with downloaded body + * @param length - Length of Readable stream, needed for Node.js environment */ export async function bodyToString( response: { From b16d29d835f43f4dca8fcec6600e27598d4df414 Mon Sep 17 00:00:00 2001 From: Ramya Achutha Rao Date: Thu, 18 Feb 2021 18:34:04 -0800 Subject: [PATCH 2/2] Add back docs for AccessPolicy to avoid changing api file --- sdk/storage/storage-blob/src/ContainerClient.ts | 1 + sdk/storage/storage-file-share/src/Clients.ts | 1 + sdk/storage/storage-queue/src/QueueClient.ts | 1 + 3 files changed, 3 insertions(+) diff --git a/sdk/storage/storage-blob/src/ContainerClient.ts b/sdk/storage/storage-blob/src/ContainerClient.ts index 8173719872bf..85ac00b3b96c 100644 --- a/sdk/storage/storage-blob/src/ContainerClient.ts +++ b/sdk/storage/storage-blob/src/ContainerClient.ts @@ -177,6 +177,7 @@ export interface SignedIdentifier { */ id: string; /** + * Access Policy */ accessPolicy: { /** diff --git a/sdk/storage/storage-file-share/src/Clients.ts b/sdk/storage/storage-file-share/src/Clients.ts index 81f257efe3b8..07944212b84b 100644 --- a/sdk/storage/storage-file-share/src/Clients.ts +++ b/sdk/storage/storage-file-share/src/Clients.ts @@ -316,6 +316,7 @@ export interface SignedIdentifier { */ id: string; /** + * Access Policy */ accessPolicy: { /** diff --git a/sdk/storage/storage-queue/src/QueueClient.ts b/sdk/storage/storage-queue/src/QueueClient.ts index 5e3480a51033..ec10be438a36 100644 --- a/sdk/storage/storage-queue/src/QueueClient.ts +++ b/sdk/storage/storage-queue/src/QueueClient.ts @@ -143,6 +143,7 @@ export interface SignedIdentifier { */ id: string; /** + * Access Policy */ accessPolicy: { /**