@azure/storage-file-share - npm Package Compare versions

Comparing version 12.0.0-dev.20191125.1 to 12.0.0-dev.20191126.1

BreakingChanges.md

@@ -7,2 +7,5 @@ # Breaking Changes
 - [Breaking] The `expiryTime` and `startTime` members of the `AccountSASSignatureValues` and `FileSASSignatureValues` types, as well as the `expiry` and `start` members of the `accessPolicy` field of the `SignedIdentifier` type, have all been renamed to `expiresOn` and `startsOn` respectively for consistency with `@azure/storage-blob` and `@azure/storage-queue`.
+- [Breaking] `shareName` on `ShareClient` has been renamed to `name`. [PR 6135](https://github.com/Azure/azure-sdk-for-js/pull/6135)
+- [Breaking] In browsers, `blobBody` on `FileDownloadResponse` has been renamed to `contentAsBlob` in order to avoid naming confusion between browser `Blob` objects and `Blob`s from `@azure/storage-blob`. [PR 6183](https://github.com/Azure/azure-sdk-for-js/pull/6183) 
+- [Breaking] Removed `uploadBrowserData` from `ShareFileClient` in favor of a unified method `uploadData` that accepts both browser `Blob` objects as well as Node.js `Buffer` objects.
 
@@ -9,0 +12,0 @@ ## 2019.11 12.0.0-preview.6

ChangeLog.md

@@ -9,2 +9,7 @@ # Changelog
 - Bug Fix - Convert empty prefixes (`""`) to `undefined` when passed as options to the `listFiles` or `listShares` methods to avoid sending an invalid request to the service. Fixes bug [5817](https://github.com/Azure/azure-sdk-for-js/issues/5817).
+- The `ShareFileClient.downloadToBuffer()` helper method has a new overload where it is not required to pass a `Buffer`. The attributes `offset` and `count` are optional, and it downloads the entire file if they are not provided.
+- [Breaking] `shareName` on `ShareClient` has been renamed to `name`. [PR 6135](https://github.com/Azure/azure-sdk-for-js/pull/6135)
+- `ShareFileClient` and `ShareDirectoryClient` now have a `name` property that returns the file or directory name respectively. [PR 6135](https://github.com/Azure/azure-sdk-for-js/pull/6135)
+- [Breaking] In browsers, `blobBody` on `FileDownloadResponse` has been renamed to `contentAsBlob` in order to avoid naming confusion between browser `Blob` objects and `Blob`s from `@azure/storage-blob`. [PR 6183](https://github.com/Azure/azure-sdk-for-js/pull/6183)
+- [Breaking] Removed `uploadBrowserData` from `ShareFileClient` in favor of a unified method `uploadData` that accepts both browser `Blob` objects as well as Node.js `Buffer` objects.
 
@@ -11,0 +16,0 @@ ## 2019.11 12.0.0-preview.6

dist-esm/src/ShareClient.js

@@ -346,2 +346,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved.
      *
+     * WARNING: The `metadata` object returned in the response will have its keys in lowercase, even if
+     * they originally contained uppercase characters. This differs from the metadata keys returned by
+     * the `listShares` method of {@link ShareServiceClient} using the `includeMetadata` option, which
+     * will retain their original casing.
+     *
      * @returns {Promise<ShareGetPropertiesResponse>} Response data for the Share Get Properties operation.
@@ -348,0 +353,0 @@ * @memberof ShareClient

package.json

 {
   "name": "@azure/storage-file-share",
   "sdk-type": "client",
-  "version": "12.0.0-dev.20191125.1",
+  "version": "12.0.0-dev.20191126.1",
   "description": "Microsoft Azure Storage SDK for JavaScript - File",
@@ -27,3 +27,3 @@ "main": "./dist/index.js",
     "build:js-samples": "npm run clean && npm run build:es6 && cross-env ONLY_NODE=true rollup -c 2>&1",
-    "build:ts-samples": "npm run clean && cd samples && tsc -p . ",
+    "build:ts-samples": "npm run clean && node ../../../common/scripts/prep-samples.js && cd samples && tsc -p . ",
     "build:test": "npm run build:es6 && rollup -c rollup.test.config.js 2>&1",
@@ -33,2 +33,3 @@ "build": "npm run build:es6 && npm run build:nodebrowser && api-extractor run --local",
     "clean": "rimraf dist dist-esm dist-test typings temp browser/*.js* browser/*.zip statistics.html coverage coverage-browser .nyc_output *.tgz *.log test*.xml TEST*.xml",
+    "clean:samples": "rimraf samples/javascript/node_modules samples/typescript/node_modules samples/typescript/dist",
     "extract-api": "tsc -p . && api-extractor run --local",
@@ -35,0 +36,0 @@ "execute:samples": "node execute-samples.js",

src/ShareClient.ts

@@ -691,2 +691,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved.
    *
+   * WARNING: The `metadata` object returned in the response will have its keys in lowercase, even if
+   * they originally contained uppercase characters. This differs from the metadata keys returned by
+   * the `listShares` method of {@link ShareServiceClient} using the `includeMetadata` option, which
+   * will retain their original casing.
+   *
    * @returns {Promise<ShareGetPropertiesResponse>} Response data for the Share Get Properties operation.
@@ -693,0 +698,0 @@ * @memberof ShareClient

typings/src/ShareClient.d.ts

@@ -452,2 +452,7 @@ import { HttpResponse } from "@azure/core-http";
      *
+     * WARNING: The `metadata` object returned in the response will have its keys in lowercase, even if
+     * they originally contained uppercase characters. This differs from the metadata keys returned by
+     * the `listShares` method of {@link ShareServiceClient} using the `includeMetadata` option, which
+     * will retain their original casing.
+     *
      * @returns {Promise<ShareGetPropertiesResponse>} Response data for the Share Get Properties operation.
@@ -454,0 +459,0 @@ * @memberof ShareClient

No alert changes

Improved metrics

Total package byte prevSize

3084278

increased by0.12%

Lines of code

55357

increased by0.04%

No dependency changes