Azure/azure-sdk-for-js @azure/storage-file_12.0.0-preview.1

on GitHub

2019.07 Version 12.0.0-preview.1

• [Breaking] Client types are renamed from *URL to *Client.

  • ServiceURL, ShareURL, DirectoryURL and FileURL to FileServiceClient, ShareClient, DirectoryClient and FileClient respectively.

• [Breaking] Aborter parameters are now moved into option bags.

  • abortSignal attrubute(optional) in the option-bag of respective module has to be utitlized for the Aborter.timeout(<milliseconds>) functionality.
  • Aborter.none is the default value.

• [Breaking] I- prefixes are removed from interface names.

  • Example- IDirectoryCreateOptions is updated to DirectoryCreateOptions, the new names must to be used.

• [Breaking] The static methods to create client types are removed. The functionality is moved into new instance methods added to the parent clients.

• [Breaking] The telemetry strings have been updated.

  • Azure-Storage/${SDK_VERSION} is updated to azsdk-js-storageblob/${SDK_VERSION}.

• [Breaking] withPipeline() method is removed.

• Async iterators with pagination support are added for listing methods

  • listFilesAndDirectories() and listShares()
  • Please refer to the samples for async iterators in the samples folder.

• [Breaking] Methods that list segments(listFilesAndDirectoriesSegment() and listSharesSegment()) are no longer exposed in public api.

• [Breaking] High level convenience functions are moved into clients as their instance member function.

  • uploadFileToAzureFile(), uploadStreamToAzureFile(), downloadAzureFileToBuffer() and uploadBrowserDataToAzureFile() -> FileClient.uploadFile(),
    FileClient.uploadStream(), FileClient.downloadToBuffer() and FileClient.uploadBrowserData() respectively.

• [Breaking] StorageClient is no longer exposed. StorageClient.newPipeline() static method is moved to the top level exported function newPipeline().

• Updated dependency @azure/ms-rest-js to @azure/core-http.

• Constructor overloads added into client types so they can be constructed from a url and a pipeline/credential and connection string.

  • Constructors with overloads - FileServiceClient and ShareClient
  • Connection string method is supported only in Node.js (not browsers).

• Creation/Deletion of child resources are duplicated to parent client type.

• HTTP proxy support is added (Node.js only).

  • Please refer to the proxyAuth.ts sample in the samples/typescript folder.

• Request and response headers are now logged at INFO level, with sensitive data redacted.

• downloadToFile() is added to FileClient.

For release notes and more information please visit https://aka.ms/azure-sdk-preview1-js