@azure/storage-file-datalake
Advanced tools
@azure/storage-file-datalake - npm Package Compare versions
Comparing version 12.4.0-alpha.20210210.1 to 12.4.0-alpha.20210218.1
@@ -34,10 +34,10 @@ // Copyright (c) Microsoft Corporation. | ||
| * | ||
| * @param {Readable} readable A Node.js Readable stream | ||
| * @param {number} bufferSize Buffer size of every maintained buffer | ||
| * @param {number} maxBuffers How many buffers can be allocated | ||
| * @param {OutgoingHandler} outgoingHandler An async function scheduled to be | ||
| * @param readable - A Node.js Readable stream | ||
| * @param bufferSize - Buffer size of every maintained buffer | ||
| * @param maxBuffers - How many buffers can be allocated | ||
| * @param outgoingHandler - An async function scheduled to be | ||
| * triggered when a buffer fully filled | ||
| * with stream data | ||
| * @param {number} concurrency Concurrency of executing outgoingHandlers (>0) | ||
| * @param {string} [encoding] [Optional] Encoding of Readable stream when it's a string stream | ||
| * @param concurrency - Concurrency of executing outgoingHandlers (>0) | ||
| * @param encoding - [Optional] Encoding of Readable stream when it's a string stream | ||
| * @memberof BufferScheduler | ||
@@ -150,3 +150,3 @@ */ | ||
| * | ||
| * @returns {Promise<void>} | ||
| * | ||
| * @memberof BufferScheduler | ||
@@ -206,3 +206,3 @@ */ | ||
| * @private | ||
| * @param {Buffer} data | ||
| * @param data - | ||
| * @memberof BufferScheduler | ||
@@ -219,3 +219,3 @@ */ | ||
| * @private | ||
| * @returns {PooledBuffer} | ||
| * | ||
| * @memberof BufferScheduler | ||
@@ -241,3 +241,3 @@ */ | ||
| * @private | ||
| * @returns {boolean} Return false when buffers in incoming are not enough, else true. | ||
| * @returns Return false when buffers in incoming are not enough, else true. | ||
| * @memberof BufferScheduler | ||
@@ -295,4 +295,4 @@ */ | ||
| * @private | ||
| * @param {Buffer} buffer | ||
| * @returns {Promise<any>} | ||
| * @param buffer - | ||
| * | ||
| * @memberof BufferScheduler | ||
@@ -333,3 +333,3 @@ */ | ||
| * @private | ||
| * @param {Buffer} buffer | ||
| * @param buffer - | ||
| * @memberof BufferScheduler | ||
@@ -336,0 +336,0 @@ */ |
@@ -17,4 +17,4 @@ // Copyright (c) Microsoft Corporation. | ||
| * | ||
| * @param {Buffer[]} buffers Array of buffers containing the data | ||
| * @param {number} byteLength The total length of data contained in the buffers | ||
| * @param buffers - Array of buffers containing the data | ||
| * @param byteLength - The total length of data contained in the buffers | ||
| * @memberof BuffersStream | ||
@@ -43,3 +43,3 @@ */ | ||
| * | ||
| * @param {number} size Optional. The size of data to be read | ||
| * @param size - Optional. The size of data to be read | ||
| * @memberof BuffersStream | ||
@@ -46,0 +46,0 @@ */ |
@@ -61,6 +61,6 @@ // Copyright (c) Microsoft Corporation. | ||
| * | ||
| * @param {Buffer[]} buffers Input buffers containing the data to be filled in the pooled buffer | ||
| * @param {number} totalLength Total length of the data to be filled in. | ||
| * @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. | ||
| * | ||
| * @returns {void} | ||
| * | ||
| * @memberof PooledBuffer | ||
@@ -96,3 +96,3 @@ */ | ||
| * | ||
| * @returns {Readable} | ||
| * | ||
| * @memberof PooledBuffer | ||
@@ -99,0 +99,0 @@ */ |
@@ -24,5 +24,5 @@ // Copyright (c) Microsoft Corporation. | ||
| * | ||
| * @param {RequestPolicy} nextPolicy | ||
| * @param {RequestPolicyOptions} options | ||
| * @returns {AnonymousCredentialPolicy} | ||
| * @param nextPolicy - | ||
| * @param options - | ||
| * | ||
| * @memberof AnonymousCredential | ||
@@ -29,0 +29,0 @@ */ |
@@ -17,5 +17,5 @@ // Copyright (c) Microsoft Corporation. | ||
| * | ||
| * @param {RequestPolicy} _nextPolicy | ||
| * @param {RequestPolicyOptions} _options | ||
| * @returns {RequestPolicy} | ||
| * @param _nextPolicy - | ||
| * @param _options - | ||
| * | ||
| * @memberof Credential | ||
@@ -22,0 +22,0 @@ */ |
@@ -20,4 +20,4 @@ // Copyright (c) Microsoft Corporation. | ||
| * Creates an instance of StorageSharedKeyCredential. | ||
| * @param {string} accountName | ||
| * @param {string} accountKey | ||
| * @param accountName - | ||
| * @param accountKey - | ||
| * @memberof StorageSharedKeyCredential | ||
@@ -34,5 +34,5 @@ */ | ||
| * | ||
| * @param {RequestPolicy} nextPolicy | ||
| * @param {RequestPolicyOptions} options | ||
| * @returns {StorageSharedKeyCredentialPolicy} | ||
| * @param nextPolicy - | ||
| * @param options - | ||
| * | ||
| * @memberof StorageSharedKeyCredential | ||
@@ -46,4 +46,4 @@ */ | ||
| * | ||
| * @param {string} stringToSign | ||
| * @returns {string} | ||
| * @param stringToSign - | ||
| * | ||
| * @memberof StorageSharedKeyCredential | ||
@@ -50,0 +50,0 @@ */ |
@@ -16,4 +16,4 @@ // Copyright (c) Microsoft Corporation. | ||
| * Creates an instance of UserDelegationKeyCredential. | ||
| * @param {string} accountName | ||
| * @param {UserDelegationKey} userDelegationKey | ||
| * @param accountName - | ||
| * @param userDelegationKey - | ||
| * @memberof UserDelegationKeyCredential | ||
@@ -29,4 +29,4 @@ */ | ||
| * | ||
| * @param {string} stringToSign | ||
| * @returns {string} | ||
| * @param stringToSign - | ||
| * | ||
| * @memberof UserDelegationKeyCredential | ||
@@ -33,0 +33,0 @@ */ |
@@ -62,4 +62,4 @@ import { __assign, __asyncDelegator, __asyncGenerator, __asyncValues, __await, __awaiter, __extends, __generator, __values } from "tslib"; | ||
| * | ||
| * @param {string} directoryName | ||
| * @returns {DataLakeDirectoryClient} | ||
| * @param directoryName - | ||
| * | ||
| * @memberof DataLakeFileSystemClient | ||
@@ -73,4 +73,4 @@ */ | ||
| * | ||
| * @param {string} fileName | ||
| * @returns {DataLakeFileClient} | ||
| * @param fileName - | ||
| * | ||
| * @memberof DataLakeFileSystemClient | ||
@@ -84,4 +84,4 @@ */ | ||
| * | ||
| * @param {string} [proposeLeaseId] Optional. Initial proposed lease Id. | ||
| * @returns {DataLakeLeaseClient} | ||
| * @param proposeLeaseId - Optional. Initial proposed lease Id. | ||
| * | ||
| * @memberof DataLakeFileSystemClient | ||
@@ -98,4 +98,4 @@ */ | ||
| * | ||
| * @param {FileSystemCreateOptions} [options={}] Optional. Options when creating file system. | ||
| * @returns {Promise<FileSystemCreateResponse>} | ||
| * @param options - Optional. Options when creating file system. | ||
| * | ||
| * @memberof DataLakeFileSystemClient | ||
@@ -137,4 +137,4 @@ */ | ||
| * | ||
| * @param {FileSystemCreateOptions} [options={}] | ||
| * @returns {Promise<FileSystemCreateIfNotExistsResponse>} | ||
| * @param options - | ||
| * | ||
| * @memberof DataLakeFileSystemClient | ||
@@ -177,4 +177,4 @@ */ | ||
| * | ||
| * @param {FileSystemExistsOptions} [options={}] | ||
| * @returns {Promise<boolean>} | ||
| * @param options - | ||
| * | ||
| * @memberof DataLakeFileSystemClient | ||
@@ -215,4 +215,4 @@ */ | ||
| * | ||
| * @param {FileSystemDeleteOptions} [options={}] Optional. Options when deleting file system. | ||
| * @returns {Promise<FileSystemDeleteResponse>} | ||
| * @param options - Optional. Options when deleting file system. | ||
| * | ||
| * @memberof DataLakeFileSystemClient | ||
@@ -253,4 +253,4 @@ */ | ||
| * | ||
| * @param {FileSystemDeleteOptions} [options={}] | ||
| * @returns {Promise<FileSystemDeleteIfExistsResponse>} | ||
| * @param options - | ||
| * | ||
| * @memberof DataLakeFileSystemClient | ||
@@ -297,4 +297,4 @@ */ | ||
| * | ||
| * @param {FileSystemGetPropertiesOptions} [options={}] Optional. Options when getting file system properties. | ||
| * @returns {Promise<FileSystemGetPropertiesResponse>} | ||
| * @param options - Optional. Options when getting file system properties. | ||
| * | ||
| * @memberof DataLakeFileSystemClient | ||
@@ -345,6 +345,6 @@ */ | ||
| * | ||
| * @param {Metadata} [metadata] Replace existing metadata with this value. | ||
| * @param metadata - Replace existing metadata with this value. | ||
| * If no value provided the existing metadata will be removed. | ||
| * @param {FileSystemSetMetadataOptions} [options={}] Optional. Options when setting file system metadata. | ||
| * @returns {Promise<FileSystemSetMetadataResponse>} | ||
| * @param options - Optional. Options when setting file system metadata. | ||
| * | ||
| * @memberof DataLakeFileSystemClient | ||
@@ -389,4 +389,4 @@ */ | ||
| * | ||
| * @param {FileSystemGetAccessPolicyOptions} [options={}] Optional. Options when getting file system access policy. | ||
| * @returns {Promise<FileSystemGetAccessPolicyResponse>} | ||
| * @param options - Optional. Options when getting file system access policy. | ||
| * | ||
| * @memberof DataLakeFileSystemClient | ||
@@ -439,6 +439,6 @@ */ | ||
| * | ||
| * @param {PublicAccessType} [access] Optional. The level of public access to data in the file system. | ||
| * @param {SignedIdentifier<AccessPolicy>[]} [fileSystemAcl] Optional. Array of elements each having a unique Id and details of the access policy. | ||
| * @param {FileSystemSetAccessPolicyOptions} [options={}] Optional. Options when setting file system access policy. | ||
| * @returns {Promise<FileSystemSetAccessPolicyResponse>} | ||
| * @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 | ||
@@ -543,4 +543,4 @@ */ | ||
| * | ||
| * @param {ListPathsOptions} [options={}] Optional. Options when listing paths. | ||
| * @returns {PagedAsyncIterableIterator<Path, FileSystemListPathsResponse>} | ||
| * @param options - Optional. Options when listing paths. | ||
| * | ||
| * @memberof DataLakeFileSystemClient | ||
@@ -682,4 +682,4 @@ */ | ||
| * | ||
| * @param {FileSystemGenerateSasUrlOptions} options Optional parameters. | ||
| * @returns {Promise<string>} The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token. | ||
| * @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 | ||
@@ -686,0 +686,0 @@ */ |
@@ -54,3 +54,3 @@ // Copyright (c) Microsoft Corporation. | ||
| * | ||
| * @param {string} connectionString Account connection string or a SAS connection string of an Azure storage account. | ||
| * @param connectionString - Account connection string or a SAS connection string of an Azure storage account. | ||
| * [ Note - Account connection string can only be used in NODE.JS runtime. ] | ||
@@ -61,3 +61,3 @@ * Account 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 {StoragePipelineOptions} [options] Optional. Options to configure the HTTP pipeline. | ||
| * @param options - Optional. Options to configure the HTTP pipeline. | ||
| * @memberof DataLakeServiceClient | ||
@@ -90,4 +90,4 @@ */ | ||
| * | ||
| * @param {string} fileSystemName File system name. | ||
| * @returns {DataLakeFileSystemClient} | ||
| * @param fileSystemName - File system name. | ||
| * | ||
| * @memberof DataLakeServiceClient | ||
@@ -123,6 +123,6 @@ */ | ||
| * | ||
| * @param {Date} startsOn The start time for the user delegation SAS. Must be within 7 days of the current time. | ||
| * @param {Date} expiresOn The end time for the user delegation SAS. Must be within 7 days of the current time. | ||
| * @param {ServiceGetUserDelegationKeyOptions} [options={}] | ||
| * @returns {Promise<ServiceGetUserDelegationKeyResponse>} | ||
| * @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 | ||
@@ -231,4 +231,4 @@ */ | ||
| * | ||
| * @param {ServiceListFileSystemsOptions} [options={}] | ||
| * @returns {PagedAsyncIterableIterator<FileSystemItem, ServiceListFileSystemsSegmentResponse>} | ||
| * @param options - | ||
| * | ||
| * @memberof DataLakeServiceClient | ||
@@ -254,7 +254,7 @@ */ | ||
| * | ||
| * @param {Date} expiresOn Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not specified. | ||
| * @param {AccountSASPermissions} [permissions=AccountSASPermissions.parse("r")] Specifies the list of permissions to be associated with the SAS. | ||
| * @param {string} [resourceTypes="sco"] Specifies the resource types associated with the shared access signature. | ||
| * @param {ServiceGenerateAccountSasUrlOptions} [options={}] Optional parameters. | ||
| * @returns {string} An account SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token. | ||
| * @param expiresOn - Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not specified. | ||
| * @param permissions - Specifies the list of permissions to be associated with the SAS. | ||
| * @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 | ||
@@ -281,5 +281,5 @@ */ | ||
| * | ||
| * @param {string} sourceFileSystemName The name of the source File System. | ||
| * @param {string} destinationContainerName The new name of the File System. | ||
| * @param {ServiceRenameFileSystemOptions} [options] Options to configure File System Rename operation. | ||
| * @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 | ||
@@ -326,5 +326,5 @@ */ | ||
| * | ||
| * @param {string} deletedFileSystemName The name of the source File System. | ||
| * @param {string} deleteFileSystemVersion The new name of the File System. | ||
| * @param {ServiceRenameFileSystemOptions} [options] Options to configure File System Restore operation. | ||
| * @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 | ||
@@ -331,0 +331,0 @@ */ |
@@ -34,4 +34,4 @@ // Copyright (c) Microsoft Corporation. | ||
| * | ||
| * @param {RequestPolicyFactory[]} factories | ||
| * @param {PipelineOptions} [options={}] | ||
| * @param factories - | ||
| * @param options - | ||
| * @memberof Pipeline | ||
@@ -52,3 +52,3 @@ */ | ||
| * | ||
| * @returns {ServiceClientOptions} The ServiceClientOptions object from this Pipeline. | ||
| * @returns The ServiceClientOptions object from this Pipeline. | ||
| * @memberof Pipeline | ||
@@ -69,5 +69,5 @@ */ | ||
| * @export | ||
| * @param {StorageSharedKeyCredential | AnonymousCredential | TokenCredential} 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 {StoragePipelineOptions} [pipelineOptions] Optional. Options. | ||
| * @returns {Pipeline} A new Pipeline object. | ||
| * @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. | ||
| */ | ||
@@ -111,5 +111,5 @@ export function newPipeline(credential, pipelineOptions) { | ||
| * @export | ||
| * @param {T} thing | ||
| * @param {TokenCredential} credential | ||
| * @returns {T} | ||
| * @param thing - | ||
| * @param credential - | ||
| * | ||
| */ | ||
@@ -116,0 +116,0 @@ function attachCredential(thing, credential) { |
@@ -17,4 +17,4 @@ // Copyright (c) Microsoft Corporation. | ||
| * Creates an instance of AnonymousCredentialPolicy. | ||
| * @param {RequestPolicy} nextPolicy | ||
| * @param {RequestPolicyOptions} options | ||
| * @param nextPolicy - | ||
| * @param options - | ||
| * @memberof AnonymousCredentialPolicy | ||
@@ -21,0 +21,0 @@ */ |
@@ -22,4 +22,4 @@ // Copyright (c) Microsoft Corporation. | ||
| * | ||
| * @param {WebResource} request | ||
| * @returns {Promise<HttpOperationResponse>} | ||
| * @param request - | ||
| * | ||
| * @memberof CredentialPolicy | ||
@@ -36,4 +36,4 @@ */ | ||
| * @abstract | ||
| * @param {WebResource} request | ||
| * @returns {WebResource} | ||
| * @param request - | ||
| * | ||
| * @memberof CredentialPolicy | ||
@@ -40,0 +40,0 @@ */ |
@@ -25,4 +25,4 @@ import { __awaiter, __extends, __generator } from "tslib"; | ||
| * Creates an instance of StorageBrowserPolicy. | ||
| * @param {RequestPolicy} nextPolicy | ||
| * @param {RequestPolicyOptions} options | ||
| * @param nextPolicy - | ||
| * @param options - | ||
| * @memberof StorageBrowserPolicy | ||
@@ -36,4 +36,4 @@ */ | ||
| * | ||
| * @param {WebResource} request | ||
| * @returns {Promise<HttpOperationResponse>} | ||
| * @param request - | ||
| * | ||
| * @memberof StorageBrowserPolicy | ||
@@ -40,0 +40,0 @@ */ |
@@ -13,3 +13,3 @@ import { __awaiter, __extends, __generator } from "tslib"; | ||
| * @export | ||
| * @param {StorageRetryOptions} retryOptions | ||
| * @param retryOptions - | ||
| */ | ||
@@ -61,5 +61,5 @@ export function NewRetryPolicyFactory(retryOptions) { | ||
| * | ||
| * @param {RequestPolicy} nextPolicy | ||
| * @param {RequestPolicyOptions} options | ||
| * @param {StorageRetryOptions} [retryOptions=DEFAULT_RETRY_OPTIONS] | ||
| * @param nextPolicy - | ||
| * @param options - | ||
| * @param retryOptions - | ||
| * @memberof StorageRetryPolicy | ||
@@ -98,4 +98,4 @@ */ | ||
| * | ||
| * @param {WebResource} request | ||
| * @returns {Promise<HttpOperationResponse>} | ||
| * @param request - | ||
| * | ||
| * @memberof StorageRetryPolicy | ||
@@ -114,9 +114,9 @@ */ | ||
| * @protected | ||
| * @param {WebResource} request | ||
| * @param {boolean} secondaryHas404 If attempt was against the secondary & it returned a StatusNotFound (404), then | ||
| * @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 {number} attempt How many retries has been attempted to performed, starting from 1, which includes | ||
| * @param attempt - How many retries has been attempted to performed, starting from 1, which includes | ||
| * the attempt will be performed by this method call. | ||
| * @returns {Promise<HttpOperationResponse>} | ||
| * | ||
| * @memberof StorageRetryPolicy | ||
@@ -174,7 +174,7 @@ */ | ||
| * @protected | ||
| * @param {boolean} isPrimaryRetry | ||
| * @param {number} attempt | ||
| * @param {HttpOperationResponse} [response] | ||
| * @param {RestError} [err] | ||
| * @returns {boolean} | ||
| * @param isPrimaryRetry - | ||
| * @param attempt - | ||
| * @param response - | ||
| * @param err - | ||
| * | ||
| * @memberof StorageRetryPolicy | ||
@@ -237,5 +237,5 @@ */ | ||
| * @private | ||
| * @param {boolean} isPrimaryRetry | ||
| * @param {number} attempt | ||
| * @param {AbortSignalLike} [abortSignal] | ||
| * @param isPrimaryRetry - | ||
| * @param attempt - | ||
| * @param abortSignal - | ||
| * @memberof StorageRetryPolicy | ||
@@ -242,0 +242,0 @@ */ |
@@ -16,5 +16,5 @@ import { __extends } from "tslib"; | ||
| * Creates an instance of StorageSharedKeyCredentialPolicy. | ||
| * @param {RequestPolicy} nextPolicy | ||
| * @param {RequestPolicyOptions} options | ||
| * @param {StorageSharedKeyCredential} factory | ||
| * @param nextPolicy - | ||
| * @param options - | ||
| * @param factory - | ||
| * @memberof StorageSharedKeyCredentialPolicy | ||
@@ -31,4 +31,4 @@ */ | ||
| * @protected | ||
| * @param {WebResource} request | ||
| * @returns {WebResource} | ||
| * @param request - | ||
| * | ||
| * @memberof StorageSharedKeyCredentialPolicy | ||
@@ -75,5 +75,5 @@ */ | ||
| * @private | ||
| * @param {WebResource} request | ||
| * @param {string} headerName | ||
| * @returns {string} | ||
| * @param request - | ||
| * @param headerName - | ||
| * | ||
| * @memberof StorageSharedKeyCredentialPolicy | ||
@@ -106,4 +106,4 @@ */ | ||
| * @private | ||
| * @param {WebResource} request | ||
| * @returns {string} | ||
| * @param request - | ||
| * | ||
| * @memberof StorageSharedKeyCredentialPolicy | ||
@@ -137,4 +137,4 @@ */ | ||
| * @private | ||
| * @param {WebResource} request | ||
| * @returns {string} | ||
| * @param request - | ||
| * | ||
| * @memberof StorageSharedKeyCredentialPolicy | ||
@@ -141,0 +141,0 @@ */ |
@@ -16,5 +16,5 @@ // Copyright (c) Microsoft Corporation. | ||
| * Creates an instance of TelemetryPolicy. | ||
| * @param {RequestPolicy} nextPolicy | ||
| * @param {RequestPolicyOptions} options | ||
| * @param {string} telemetry | ||
| * @param nextPolicy - | ||
| * @param options - | ||
| * @param telemetry - | ||
| * @memberof TelemetryPolicy | ||
@@ -30,4 +30,4 @@ */ | ||
| * | ||
| * @param {WebResource} request | ||
| * @returns {Promise<HttpOperationResponse>} | ||
| * @param request - | ||
| * | ||
| * @memberof TelemetryPolicy | ||
@@ -34,0 +34,0 @@ */ |
@@ -78,4 +78,4 @@ // Copyright (c) Microsoft Corporation. | ||
| * @static | ||
| * @param {string} permissions | ||
| * @returns {AccountSASPermissions} | ||
| * @param permissions - | ||
| * | ||
| * @memberof AccountSASPermissions | ||
@@ -127,3 +127,3 @@ */ | ||
| * | ||
| * @returns {string} | ||
| * | ||
| * @memberof AccountSASPermissions | ||
@@ -130,0 +130,0 @@ */ |
@@ -44,4 +44,4 @@ // Copyright (c) Microsoft Corporation. | ||
| * @static | ||
| * @param {string} resourceTypes | ||
| * @returns {AccountSASResourceTypes} | ||
| * @param resourceTypes - | ||
| * | ||
| * @memberof AccountSASResourceTypes | ||
@@ -74,3 +74,3 @@ */ | ||
| * | ||
| * @returns {string} | ||
| * | ||
| * @memberof AccountSASResourceTypes | ||
@@ -77,0 +77,0 @@ */ |
@@ -51,4 +51,4 @@ // Copyright (c) Microsoft Corporation. | ||
| * @static | ||
| * @param {string} services | ||
| * @returns {AccountSASServices} | ||
| * @param services - | ||
| * | ||
| * @memberof AccountSASServices | ||
@@ -82,3 +82,3 @@ */ | ||
| * | ||
| * @returns {string} | ||
| * | ||
| * @memberof AccountSASServices | ||
@@ -85,0 +85,0 @@ */ |
@@ -18,5 +18,5 @@ // Copyright (c) Microsoft Corporation. | ||
| * | ||
| * @param {AccountSASSignatureValues} accountSASSignatureValues | ||
| * @param {StorageSharedKeyCredential} sharedKeyCredential | ||
| * @returns {SASQueryParameters} | ||
| * @param accountSASSignatureValues - | ||
| * @param sharedKeyCredential - | ||
| * | ||
| * @memberof AccountSASSignatureValues | ||
@@ -23,0 +23,0 @@ */ |
@@ -89,4 +89,4 @@ // Copyright (c) Microsoft Corporation. | ||
| * @static | ||
| * @param {string} permissions | ||
| * @returns {DataLakeSASPermissions} | ||
| * @param permissions - | ||
| * | ||
| * @memberof DataLakeSASPermissions | ||
@@ -136,3 +136,3 @@ */ | ||
| * | ||
| * @returns {string} A string which represents the DataLakeSASPermissions | ||
| * @returns A string which represents the DataLakeSASPermissions | ||
| * @memberof DataLakeSASPermissions | ||
@@ -139,0 +139,0 @@ */ |
@@ -65,5 +65,5 @@ // Copyright (c) Microsoft Corporation. | ||
| * | ||
| * @param {DataLakeSASSignatureValues} dataLakeSASSignatureValues | ||
| * @param {StorageSharedKeyCredential} sharedKeyCredential | ||
| * @returns {SASQueryParameters} | ||
| * @param dataLakeSASSignatureValues - | ||
| * @param sharedKeyCredential - | ||
| * | ||
| */ | ||
@@ -131,5 +131,5 @@ function generateBlobSASQueryParameters20150405(dataLakeSASSignatureValues, sharedKeyCredential) { | ||
| * | ||
| * @param {DataLakeSASSignatureValues} dataLakeSASSignatureValues | ||
| * @param {StorageSharedKeyCredential} sharedKeyCredential | ||
| * @returns {SASQueryParameters} | ||
| * @param dataLakeSASSignatureValues - | ||
| * @param sharedKeyCredential - | ||
| * | ||
| */ | ||
@@ -210,5 +210,5 @@ function generateBlobSASQueryParameters20181109(dataLakeSASSignatureValues, sharedKeyCredential) { | ||
| * | ||
| * @param {DataLakeSASSignatureValues} dataLakeSASSignatureValues | ||
| * @param {UserDelegationKeyCredential} userDelegationKeyCredential | ||
| * @returns {SASQueryParameters} | ||
| * @param dataLakeSASSignatureValues - | ||
| * @param userDelegationKeyCredential - | ||
| * | ||
| */ | ||
@@ -295,5 +295,5 @@ function generateBlobSASQueryParametersUDK20181109(dataLakeSASSignatureValues, userDelegationKeyCredential) { | ||
| * | ||
| * @param {DataLakeSASSignatureValues} dataLakeSASSignatureValues | ||
| * @param {UserDelegationKeyCredential} userDelegationKeyCredential | ||
| * @returns {SASQueryParameters} | ||
| * @param dataLakeSASSignatureValues - | ||
| * @param userDelegationKeyCredential - | ||
| * | ||
| */ | ||
@@ -300,0 +300,0 @@ function generateBlobSASQueryParametersUDK20200210(dataLakeSASSignatureValues, userDelegationKeyCredential) { |
@@ -94,4 +94,4 @@ // Copyright (c) Microsoft Corporation. | ||
| * @static | ||
| * @param {string} permissions | ||
| * @returns {DirectorySASPermissions} | ||
| * @param permissions - | ||
| * | ||
| * @memberof DirectorySASPermissions | ||
@@ -147,3 +147,3 @@ */ | ||
| * | ||
| * @returns {string} | ||
| * | ||
| * @memberof DirectorySASPermissions | ||
@@ -150,0 +150,0 @@ */ |
@@ -94,4 +94,4 @@ // Copyright (c) Microsoft Corporation. | ||
| * @static | ||
| * @param {string} permissions | ||
| * @returns {FileSystemSASPermissions} | ||
| * @param permissions - | ||
| * | ||
| * @memberof FileSystemSASPermissions | ||
@@ -147,3 +147,3 @@ */ | ||
| * | ||
| * @returns {string} | ||
| * | ||
| * @memberof FileSystemSASPermissions | ||
@@ -150,0 +150,0 @@ */ |
@@ -9,4 +9,4 @@ // Copyright (c) Microsoft Corporation. | ||
| * @export | ||
| * @param {SasIPRange} ipRange | ||
| * @returns {string} | ||
| * @param ipRange - | ||
| * | ||
| */ | ||
@@ -13,0 +13,0 @@ export function ipRangeToString(ipRange) { |
@@ -118,3 +118,3 @@ import { ipRangeToString } from "./SasIPRange"; | ||
| * | ||
| * @returns {string} | ||
| * | ||
| * @memberof SASQueryParameters | ||
@@ -242,6 +242,6 @@ */ | ||
| * @private | ||
| * @param {string[]} queries | ||
| * @param {string} key | ||
| * @param {string} [value] | ||
| * @returns {void} | ||
| * @param queries - | ||
| * @param key - | ||
| * @param value - | ||
| * | ||
| * @memberof SASQueryParameters | ||
@@ -248,0 +248,0 @@ */ |
@@ -18,5 +18,5 @@ // Copyright (c) Microsoft Corporation. | ||
| * | ||
| * @param {RequestPolicy} nextPolicy | ||
| * @param {RequestPolicyOptions} options | ||
| * @returns {StorageBrowserPolicy} | ||
| * @param nextPolicy - | ||
| * @param options - | ||
| * | ||
| * @memberof StorageBrowserPolicyFactory | ||
@@ -23,0 +23,0 @@ */ |
@@ -19,4 +19,4 @@ // Copyright (c) Microsoft Corporation. | ||
| * Creates an instance of StorageClient. | ||
| * @param {string} url url to resource | ||
| * @param {Pipeline} pipeline request policy pipeline. | ||
| * @param url - url to resource | ||
| * @param pipeline - request policy pipeline. | ||
| * @memberof StorageClient | ||
@@ -23,0 +23,0 @@ */ |
@@ -15,3 +15,3 @@ // Copyright (c) Microsoft Corporation. | ||
| * Creates an instance of StorageRetryPolicyFactory. | ||
| * @param {StorageRetryOptions} [retryOptions] | ||
| * @param retryOptions - | ||
| * @memberof StorageRetryPolicyFactory | ||
@@ -25,5 +25,5 @@ */ | ||
| * | ||
| * @param {RequestPolicy} nextPolicy | ||
| * @param {RequestPolicyOptions} options | ||
| * @returns {StorageRetryPolicy} | ||
| * @param nextPolicy - | ||
| * @param options - | ||
| * | ||
| * @memberof StorageRetryPolicyFactory | ||
@@ -30,0 +30,0 @@ */ |
@@ -17,3 +17,3 @@ // Copyright (c) Microsoft Corporation. | ||
| * Creates an instance of TelemetryPolicyFactory. | ||
| * @param {UserAgentOptions} [telemetry] | ||
| * @param telemetry - | ||
| * @memberof TelemetryPolicyFactory | ||
@@ -46,5 +46,5 @@ */ | ||
| * | ||
| * @param {RequestPolicy} nextPolicy | ||
| * @param {RequestPolicyOptions} options | ||
| * @returns {TelemetryPolicy} | ||
| * @param nextPolicy - | ||
| * @param options - | ||
| * | ||
| * @memberof TelemetryPolicyFactory | ||
@@ -51,0 +51,0 @@ */ |
@@ -20,4 +20,4 @@ import { __assign, __awaiter, __generator } from "tslib"; | ||
| * @export | ||
| * @param {string} url | ||
| * @returns {string} | ||
| * @param url - | ||
| * | ||
| */ | ||
@@ -53,4 +53,4 @@ export function toBlobEndpointUrl(url) { | ||
| * @export | ||
| * @param {string} url | ||
| * @returns {string} | ||
| * @param url - | ||
| * | ||
| */ | ||
@@ -57,0 +57,0 @@ export function toDfsEndpointUrl(url) { |
@@ -28,3 +28,3 @@ // Copyright (c) Microsoft Corporation. | ||
| * Creates an instance of Batch. | ||
| * @param {number} [concurrency=5] | ||
| * @param concurrency - | ||
| * @memberof Batch | ||
@@ -84,3 +84,3 @@ */ | ||
| * | ||
| * @param {Operation} operation | ||
| * @param operation - | ||
| * @memberof Batch | ||
@@ -116,3 +116,3 @@ */ | ||
| * | ||
| * @returns {Promise<void>} | ||
| * | ||
| * @memberof Batch | ||
@@ -142,3 +142,3 @@ */ | ||
| * @private | ||
| * @returns {(Operation | null)} | ||
| * | ||
| * @memberof Batch | ||
@@ -157,3 +157,3 @@ */ | ||
| * @private | ||
| * @returns {void} | ||
| * | ||
| * @memberof Batch | ||
@@ -160,0 +160,0 @@ */ |
@@ -33,10 +33,10 @@ // Copyright (c) Microsoft Corporation. | ||
| * | ||
| * @param {Readable} readable A Node.js Readable stream | ||
| * @param {number} bufferSize Buffer size of every maintained buffer | ||
| * @param {number} maxBuffers How many buffers can be allocated | ||
| * @param {OutgoingHandler} outgoingHandler An async function scheduled to be | ||
| * @param readable - A Node.js Readable stream | ||
| * @param bufferSize - Buffer size of every maintained buffer | ||
| * @param maxBuffers - How many buffers can be allocated | ||
| * @param outgoingHandler - An async function scheduled to be | ||
| * triggered when a buffer fully filled | ||
| * with stream data | ||
| * @param {number} concurrency Concurrency of executing outgoingHandlers (>0) | ||
| * @param {string} [encoding] [Optional] Encoding of Readable stream when it's a string stream | ||
| * @param concurrency - Concurrency of executing outgoingHandlers (>0) | ||
| * @param encoding - [Optional] Encoding of Readable stream when it's a string stream | ||
| * @memberof BufferScheduler | ||
@@ -149,3 +149,3 @@ */ | ||
| * | ||
| * @returns {Promise<void>} | ||
| * | ||
| * @memberof BufferScheduler | ||
@@ -204,3 +204,3 @@ */ | ||
| * @private | ||
| * @param {Buffer} data | ||
| * @param data - | ||
| * @memberof BufferScheduler | ||
@@ -217,3 +217,3 @@ */ | ||
| * @private | ||
| * @returns {Buffer} | ||
| * | ||
| * @memberof BufferScheduler | ||
@@ -253,3 +253,3 @@ */ | ||
| * @private | ||
| * @returns {boolean} Return false when buffers in incoming are not enough, else true. | ||
| * @returns Return false when buffers in incoming are not enough, else true. | ||
| * @memberof BufferScheduler | ||
@@ -307,4 +307,4 @@ */ | ||
| * @private | ||
| * @param {Buffer} buffer | ||
| * @returns {Promise<any>} | ||
| * @param buffer - | ||
| * | ||
| * @memberof BufferScheduler | ||
@@ -345,3 +345,3 @@ */ | ||
| * @private | ||
| * @param {Buffer} buffer | ||
| * @param buffer - | ||
| * @memberof BufferScheduler | ||
@@ -348,0 +348,0 @@ */ |
@@ -8,4 +8,4 @@ // Copyright (c) Microsoft Corporation. | ||
| * @export | ||
| * @param {Blob} blob | ||
| * @returns {Promise<ArrayBuffer>} | ||
| * @param blob - | ||
| * | ||
| */ | ||
@@ -31,4 +31,4 @@ export function blobToArrayBuffer(blob) { | ||
| * @export | ||
| * @param {Blob} blob | ||
| * @returns {Promise<ArrayBuffer>} | ||
| * @param blob - | ||
| * | ||
| */ | ||
@@ -35,0 +35,0 @@ export function blobToString(blob) { |
@@ -55,4 +55,4 @@ import { __awaiter, __generator } from "tslib"; | ||
| * @export | ||
| * @param {string} url | ||
| * @returns {string} | ||
| * @param url - | ||
| * | ||
| */ | ||
@@ -97,4 +97,4 @@ export function escapeURLPath(url) { | ||
| * @export | ||
| * @param {string} connectionString Connection string. | ||
| * @returns {ConnectionString} String key value pairs of the storage account's url and credentials. | ||
| * @param connectionString - Connection string. | ||
| * @returns String key value pairs of the storage account's url and credentials. | ||
| */ | ||
@@ -167,4 +167,4 @@ export function extractConnectionStringParts(connectionString) { | ||
| * | ||
| * @param {string} text | ||
| * @returns {string} | ||
| * @param text - | ||
| * | ||
| */ | ||
@@ -183,5 +183,5 @@ function escape(text) { | ||
| * @export | ||
| * @param {string} url Source URL string | ||
| * @param {string} name String to be appended to URL | ||
| * @returns {string} An updated URL string | ||
| * @param url - Source URL string | ||
| * @param name - String to be appended to URL | ||
| * @returns An updated URL string | ||
| */ | ||
@@ -199,5 +199,5 @@ export function appendToURLPath(url, name) { | ||
| * @export | ||
| * @param {string} url Source URL string. | ||
| * @param {string} queryParts String to be appended to the URL query. | ||
| * @returns {string} An updated URL string. | ||
| * @param url - Source URL string. | ||
| * @param queryParts - String to be appended to the URL query. | ||
| * @returns An updated URL string. | ||
| */ | ||
@@ -221,6 +221,6 @@ export function appendToURLQuery(url, queryParts) { | ||
| * @export | ||
| * @param {string} url Source URL string | ||
| * @param {string} name Parameter name | ||
| * @param {string} [value] Parameter value | ||
| * @returns {string} An updated URL string | ||
| * @param url - Source URL string | ||
| * @param name - Parameter name | ||
| * @param value - Parameter value | ||
| * @returns An updated URL string | ||
| */ | ||
@@ -236,5 +236,5 @@ export function setURLParameter(url, name, value) { | ||
| * @export | ||
| * @param {string} url | ||
| * @param {string} name | ||
| * @returns {(string | string[] | undefined)} | ||
| * @param url - | ||
| * @param name - | ||
| * | ||
| */ | ||
@@ -249,4 +249,4 @@ export function getURLParameter(url, name) { | ||
| * @export | ||
| * @param {string} url Source URL string | ||
| * @param {string} host New host string | ||
| * @param url - Source URL string | ||
| * @param host - New host string | ||
| * @returns An updated URL string | ||
@@ -263,4 +263,4 @@ */ | ||
| * @export | ||
| * @param {string} url Source URL string | ||
| * @returns {(string | undefined)} | ||
| * @param url - Source URL string | ||
| * | ||
| */ | ||
@@ -275,5 +275,5 @@ export function getURLPath(url) { | ||
| * @export | ||
| * @param {string} url | ||
| * @param {string} [path] | ||
| * @returns {string} | ||
| * @param url - | ||
| * @param path - | ||
| * | ||
| */ | ||
@@ -289,4 +289,4 @@ export function setURLPath(url, path) { | ||
| * @export | ||
| * @param {string} url Source URL string | ||
| * @returns {(string | undefined)} | ||
| * @param url - Source URL string | ||
| * | ||
| */ | ||
@@ -301,4 +301,4 @@ export function getURLScheme(url) { | ||
| * @export | ||
| * @param {string} url Source URL string | ||
| * @returns {(string | undefined)} | ||
| * @param url - Source URL string | ||
| * | ||
| */ | ||
@@ -322,4 +322,4 @@ export function getURLPathAndQuery(url) { | ||
| * @export | ||
| * @param {string} url | ||
| * @returns {{[key: string]: string}} | ||
| * @param url - | ||
| * | ||
| */ | ||
@@ -352,3 +352,3 @@ export function getURLQueries(url) { | ||
| * | ||
| * @param {string} url | ||
| * @param url - | ||
| */ | ||
@@ -362,4 +362,4 @@ export function getURLQueryString(url) { | ||
| * | ||
| * @param {string} url | ||
| * @param {string} queryString | ||
| * @param url - | ||
| * @param queryString - | ||
| */ | ||
@@ -375,6 +375,6 @@ export function setURLQueries(url, queryString) { | ||
| * @export | ||
| * @param {Date} date | ||
| * @param {boolean} [withMilliseconds=true] If true, YYYY-MM-DDThh:mm:ss.fffffffZ will be returned; | ||
| * @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. | ||
| * @returns {string} Date string in ISO8061 format, with or without 7 milliseconds component | ||
| * @returns Date string in ISO8061 format, with or without 7 milliseconds component | ||
| */ | ||
@@ -393,4 +393,4 @@ export function truncatedISO8061Date(date, withMilliseconds) { | ||
| * @export | ||
| * @param {string} content | ||
| * @returns {string} | ||
| * @param content - | ||
| * | ||
| */ | ||
@@ -404,4 +404,4 @@ export function base64encode(content) { | ||
| * @export | ||
| * @param {string} encodedString | ||
| * @returns {string} | ||
| * @param encodedString - | ||
| * | ||
| */ | ||
@@ -415,4 +415,4 @@ export function base64decode(encodedString) { | ||
| * @export | ||
| * @param {number} blockIndex | ||
| * @returns {string} | ||
| * @param blockIndex - | ||
| * | ||
| */ | ||
@@ -436,5 +436,5 @@ export function generateBlockID(blockIDPrefix, blockIndex) { | ||
| * @export | ||
| * @param {number} timeInMs | ||
| * @param {AbortSignalLike} [aborter] | ||
| * @param {Error} [abortError] | ||
| * @param timeInMs - | ||
| * @param aborter - | ||
| * @param abortError - | ||
| */ | ||
@@ -470,6 +470,6 @@ export function delay(timeInMs, aborter, abortError) { | ||
| * @export | ||
| * @param {string} currentString | ||
| * @param {number} targetLength | ||
| * @param {string} [padString=" "] | ||
| * @returns {string} | ||
| * @param currentString - | ||
| * @param targetLength - | ||
| * @param [padString=" - "] | ||
| * | ||
| */ | ||
@@ -522,5 +522,5 @@ export function padStart(currentString, targetLength, padString) { | ||
| * @export | ||
| * @param {string} str1 | ||
| * @param {string} str2 | ||
| * @returns {boolean} | ||
| * @param str1 - | ||
| * @param str2 - | ||
| * | ||
| */ | ||
@@ -532,4 +532,4 @@ export function iEqual(str1, str2) { | ||
| * Extracts account name from the blobEndpointUrl | ||
| * @param {string} blobEndpointUrl blobEndpointUrl to extract the account name from | ||
| * @returns {string} account name | ||
| * @param blobEndpointUrl - blobEndpointUrl to extract the account name from | ||
| * @returns account name | ||
| */ | ||
@@ -536,0 +536,0 @@ export function getAccountNameFromUrl(blobEndpointUrl) { |
@@ -11,8 +11,8 @@ // Copyright (c) Microsoft Corporation. | ||
| * @export | ||
| * @param {NodeJS.ReadableStream} stream A Node.js Readable stream | ||
| * @param {Buffer} buffer Buffer to be filled, length must >= offset | ||
| * @param {number} offset From which position in the buffer to be filled, inclusive | ||
| * @param {number} end To which position in the buffer to be filled, exclusive | ||
| * @param {string} [encoding] Encoding of the Readable stream | ||
| * @returns {Promise<void>} | ||
| * @param stream - A Node.js Readable stream | ||
| * @param buffer - Buffer to be filled, length must >= 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 | ||
| * | ||
| */ | ||
@@ -58,6 +58,6 @@ export function streamToBuffer(stream, buffer, offset, end, encoding) { | ||
| * @export | ||
| * @param {NodeJS.ReadableStream} stream A Node.js Readable stream | ||
| * @param {Buffer} buffer Buffer to be filled, length must >= offset | ||
| * @param {string} [encoding] Encoding of the Readable stream | ||
| * @returns {Promise<number>} with the count of bytes read. | ||
| * @param stream - A Node.js Readable stream | ||
| * @param buffer - Buffer to be filled, length must >= offset | ||
| * @param encoding - Encoding of the Readable stream | ||
| * @returns with the count of bytes read. | ||
| * @throws {RangeError} If buffer size is not big enough. | ||
@@ -64,0 +64,0 @@ */ |
| { | ||
| "name": "@azure/storage-file-datalake", | ||
| "version": "12.4.0-alpha.20210210.1", | ||
| "version": "12.4.0-alpha.20210218.1", | ||
| "description": "Microsoft Azure Storage SDK for JavaScript - DataLake", | ||
@@ -5,0 +5,0 @@ "sdk-type": "client", |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-1.75%
2798884