@azure/storage-file-datalake 12.25.0 → 12.26.0-alpha.20250319.1

package/LICENSE

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+Copyright (c) Microsoft Corporation.
 
-Copyright (c) 2020 Microsoft
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -12,7 +12,7 @@ furnished to do so, subject to the following conditions:
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

package/README.md

@@ -13,10 +13,10 @@ key links:
 
 - [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/storage/storage-file-datalake)
 - [Package (npm)](https://www.npmjs.com/package/@azure/storage-file-datalake)
-- [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/storage-file-datalake)
-- [Product documentation](https://docs.microsoft.com/azure/storage/blobs/data-lake-storage-introduction?toc=%2fazure%2fstorage%2fblobs%2ftoc.json)
+- [API Reference Documentation](https://learn.microsoft.com/javascript/api/@azure/storage-file-datalake)
+- [Product documentation](https://learn.microsoft.com/azure/storage/blobs/data-lake-storage-introduction?toc=%2fazure%2fstorage%2fblobs%2ftoc.json)
 - [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/storage/storage-file-datalake/samples)
-- [Azure Storage Data Lake REST APIs](https://docs.microsoft.com/rest/api/storageservices/data-lake-storage-gen2)
+- [Azure Storage Data Lake REST APIs](https://learn.microsoft.com/rest/api/storageservices/data-lake-storage-gen2)
 
 ## Getting started
 
@@ -30,7 +30,7 @@ See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUP
 ### Prerequisites
 
 - An [Azure subscription](https://azure.microsoft.com/free/)
-- A [Storage Account](https://docs.microsoft.com/azure/storage/common/storage-account-create)
+- A [Storage Account](https://learn.microsoft.com/azure/storage/common/storage-account-create)
 
 ### Install the package
 
@@ -98,7 +98,7 @@ To use this client library in the browser, first you need to use a bundler. For
 
 ### CORS
 
-You need to set up [Cross-Origin Resource Sharing (CORS)](https://docs.microsoft.com/rest/api/storageservices/cross-origin-resource-sharing--cors--support-for-the-azure-storage-services) rules for your storage account if you need to develop for browsers. Go to Azure portal and Azure Storage Explorer, find your storage account, create new CORS rules for blob/queue/file/table service(s).
+You need to set up [Cross-Origin Resource Sharing (CORS)](https://learn.microsoft.com/rest/api/storageservices/cross-origin-resource-sharing--cors--support-for-the-azure-storage-services) rules for your storage account if you need to develop for browsers. Go to Azure portal and Azure Storage Explorer, find your storage account, create new CORS rules for blob/queue/file/table service(s).
 
 For example, you can create following CORS settings for debugging. But please customize the settings carefully according to your requirements in production environment.
 
@@ -171,7 +171,7 @@ Alternatively, selectively import only the types you need:
 ```javascript
 const {
   DataLakeServiceClient,
-  StorageSharedKeyCredential
+  StorageSharedKeyCredential,
 } = require("@azure/storage-file-datalake");
 ```
 
@@ -185,17 +185,17 @@ The `DataLakeServiceClient` requires an URL to the data lake service and an acce
 
 > Notice. Azure Data Lake currently reuses blob related roles like "Storage Blob Data Owner" during following AAD OAuth authentication.
 
-Setup : Reference - Authorize access to blobs (data lake) and queues with Azure Active Directory from a client application - https://docs.microsoft.com/azure/storage/common/storage-auth-aad-app
+Setup : Reference - Authorize access to blobs (data lake) and queues with Azure Active Directory from a client application - https://learn.microsoft.com/azure/storage/common/storage-auth-aad-app
 
 - Register a new AAD application and give permissions to access Azure Storage on behalf of the signed-in user.
 
-  - Register a new application in the Azure Active Directory(in the azure-portal) - https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app
+  - Register a new application in the Azure Active Directory(in the azure-portal) - https://learn.microsoft.com/azure/active-directory/develop/quickstart-register-app
   - In the `API permissions` section, select `Add a permission` and choose `Microsoft APIs`.
   - Pick `Azure Storage` and select the checkbox next to `user_impersonation` and then click `Add permissions`. This would allow the application to access Azure Storage on behalf of the signed-in user.
 
 - Grant access to Azure Data Lake data with RBAC in the Azure Portal
 
-  - RBAC roles for blobs (data lake) and queues - https://docs.microsoft.com/azure/storage/common/storage-auth-aad-rbac-portal.
+  - RBAC roles for blobs (data lake) and queues - https://learn.microsoft.com/azure/storage/common/storage-auth-aad-rbac-portal.
   - In the azure portal, go to your storage-account and assign **Storage Blob Data Contributor** role to the registered AAD application from `Access control (IAM)` tab (in the left-side-navbar of your storage account in the azure-portal).
 
 - Environment setup for the sample
@@ -212,7 +212,7 @@ const defaultAzureCredential = new DefaultAzureCredential();
 
 const datalakeServiceClient = new DataLakeServiceClient(
   `https://${account}.dfs.core.windows.net`,
-  defaultAzureCredential
+  defaultAzureCredential,
 );
 ```
 
@@ -241,7 +241,7 @@ Alternatively, you instantiate a `DataLakeServiceClient` with a `StorageSharedKe
 ```javascript
 const {
   DataLakeServiceClient,
-  StorageSharedKeyCredential
+  StorageSharedKeyCredential,
 } = require("@azure/storage-file-datalake");
 
 // Enter your storage account name and shared key
@@ -253,7 +253,7 @@ const accountKey = "<accountkey>";
 const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);
 const datalakeServiceClient = new DataLakeServiceClient(
   `https://${account}.dfs.core.windows.net`,
-  sharedKeyCredential
+  sharedKeyCredential,
 );
 ```
 
@@ -267,7 +267,7 @@ const { DataLakeServiceClient } = require("@azure/storage-file-datalake");
 const account = "<account name>";
 const sas = "<service Shared Access Signature Token>";
 const serviceClientWithSAS = new DataLakeServiceClient(
-  `https://${account}.dfs.core.windows.net${sas}`
+  `https://${account}.dfs.core.windows.net${sas}`,
 );
 ```
 
@@ -284,7 +284,7 @@ const defaultAzureCredential = new DefaultAzureCredential();
 
 const datalakeServiceClient = new DataLakeServiceClient(
   `https://${account}.dfs.core.windows.net`,
-  defaultAzureCredential
+  defaultAzureCredential,
 );
 
 async function main() {
@@ -312,7 +312,7 @@ const defaultAzureCredential = new DefaultAzureCredential();
 
 const datalakeServiceClient = new DataLakeServiceClient(
   `https://${account}.dfs.core.windows.net`,
-  defaultAzureCredential
+  defaultAzureCredential,
 );
 
 async function main() {
@@ -337,7 +337,7 @@ const defaultAzureCredential = new DefaultAzureCredential();
 
 const datalakeServiceClient = new DataLakeServiceClient(
   `https://${account}.dfs.core.windows.net`,
-  defaultAzureCredential
+  defaultAzureCredential,
 );
 
 async function main() {
@@ -364,7 +364,7 @@ const defaultAzureCredential = new DefaultAzureCredential();
 
 const datalakeServiceClient = new DataLakeServiceClient(
   `https://${account}.dfs.core.windows.net`,
-  defaultAzureCredential
+  defaultAzureCredential,
 );
 
 async function main() {
@@ -394,7 +394,7 @@ const defaultAzureCredential = new DefaultAzureCredential();
 
 const datalakeServiceClient = new DataLakeServiceClient(
   `https://${account}.dfs.core.windows.net`,
-  defaultAzureCredential
+  defaultAzureCredential,
 );
 
 const fileSystemName = "<file system name>";
@@ -420,7 +420,7 @@ const defaultAzureCredential = new DefaultAzureCredential();
 
 const datalakeServiceClient = new DataLakeServiceClient(
   `https://${account}.dfs.core.windows.net`,
-  defaultAzureCredential
+  defaultAzureCredential,
 );
 
 const fileSystemName = "<file system name>";
@@ -453,7 +453,7 @@ const defaultAzureCredential = new DefaultAzureCredential();
 
 const datalakeServiceClient = new DataLakeServiceClient(
   `https://${account}.dfs.core.windows.net`,
-  defaultAzureCredential
+  defaultAzureCredential,
 );
 
 const fileSystemName = "<file system name>";
@@ -482,7 +482,7 @@ const defaultAzureCredential = new DefaultAzureCredential();
 
 const datalakeServiceClient = new DataLakeServiceClient(
   `https://${account}.dfs.core.windows.net`,
-  defaultAzureCredential
+  defaultAzureCredential,
 );
 
 const fileSystemName = "<file system name>";
@@ -503,7 +503,7 @@ async function main() {
     return new Promise((resolve, reject) => {
       const chunks = [];
       readableStream.on("data", (data) => {
-        chunks.push(data instanceof Buffer ? data : Buffer.from(data));
+        chunks.push(typeof data === "string" ? Buffer.from(data) : data);
       });
       readableStream.on("end", () => {
         resolve(Buffer.concat(chunks));
@@ -525,11 +525,11 @@ const account = "<account>";
 const sas = "<sas token>";
 
 const datalakeServiceClient = new DataLakeServiceClient(
-  `https://${account}.dfs.core.windows.net${sas}`
+  `https://${account}.dfs.core.windows.net${sas}`,
 );
 
 const fileSystemName = "<file system name>";
-const fileName = "<file name>"
+const fileName = "<file name>";
 
 async function main() {
   const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);
@@ -539,10 +539,7 @@ async function main() {
   // In browsers, get downloaded data by accessing downloadResponse.contentAsBlob
   const downloadResponse = await fileClient.read();
   const downloaded = await blobToString(await downloadResponse.contentAsBlob);
-  console.log(
-    "Downloaded file content",
-    downloaded
-  );
+  console.log("Downloaded file content", downloaded);
 
   // [Browsers only] A helper method used to convert a browser Blob into string.
   async function blobToString(blob) {
@@ -581,5 +578,3 @@ More code samples:
 ## Contributing
 
 If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
-
-![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fstorage%2Fstorage-blob%2FREADME.png)