From 45d461947d7a74769b389e69072ba6bc4427535a Mon Sep 17 00:00:00 2001 From: Maor Leger Date: Wed, 16 Jun 2021 14:11:03 -0700 Subject: [PATCH] [Storage] - Add information about web worker compatibility --- sdk/storage/storage-blob/README.md | 13 +++++++++++++ sdk/storage/storage-file-datalake/README.md | 13 +++++++++++++ sdk/storage/storage-file-share/README.md | 13 +++++++++++++ sdk/storage/storage-queue/README.md | 13 +++++++++++++ 4 files changed, 52 insertions(+) diff --git a/sdk/storage/storage-blob/README.md b/sdk/storage/storage-blob/README.md index 584f7164bbf5..8d5aefdae8c1 100644 --- a/sdk/storage/storage-blob/README.md +++ b/sdk/storage/storage-blob/README.md @@ -66,6 +66,19 @@ This library depends on following ES features which need external polyfills load - `Symbol.iterator` - `Number.isInteger` +#### Web Workers + +This library requires certain DOM objects to be globally available when used in the browser, which web workers do not make available by default. You will need to polyfill these to make this library work in web workers. + +For more information please refer to our [documentation for using Azure SDK for JS in Web Workers](https://aka.ms/azsdk/js/web-workers) + +This library depends on following DOM APIs which need external polyfills loaded when used in web workers: + +- [`document`](https://developer.mozilla.org/docs/Web/API/Document) +- [`DOMParser`](https://developer.mozilla.org/docs/Web/API/DOMParser) +- [`Node`](https://developer.mozilla.org/docs/Web/API/Node) +- [`XMLSerializer`](https://developer.mozilla.org/docs/Web/API/XMLSerializer) + #### Differences between Node.js and browsers There are differences between Node.js and browsers runtime. When getting started with this library, pay attention to APIs or classes marked with _"ONLY AVAILABLE IN NODE.JS RUNTIME"_ or _"ONLY AVAILABLE IN BROWSERS"_. diff --git a/sdk/storage/storage-file-datalake/README.md b/sdk/storage/storage-file-datalake/README.md index d1d7949dd657..ee9cb66091d5 100644 --- a/sdk/storage/storage-file-datalake/README.md +++ b/sdk/storage/storage-file-datalake/README.md @@ -62,6 +62,19 @@ This library depends on following ES features which need external polyfills load - `Symbol` - `Symbol.iterator` +#### Web Workers + +This library requires certain DOM objects to be globally available when used in the browser, which web workers do not make available by default. You will need to polyfill these to make this library work in web workers. + +For more information please refer to our [documentation for using Azure SDK for JS in Web Workers](https://aka.ms/azsdk/js/web-workers) + +This library depends on following DOM APIs which need external polyfills loaded when used in web workers: + +- [`document`](https://developer.mozilla.org/docs/Web/API/Document) +- [`DOMParser`](https://developer.mozilla.org/docs/Web/API/DOMParser) +- [`Node`](https://developer.mozilla.org/docs/Web/API/Node) +- [`XMLSerializer`](https://developer.mozilla.org/docs/Web/API/XMLSerializer) + #### Differences between Node.js and browsers There are differences between Node.js and browsers runtime. When getting started with this library, pay attention to APIs or classes marked with _"ONLY AVAILABLE IN NODE.JS RUNTIME"_ or _"ONLY AVAILABLE IN BROWSERS"_. diff --git a/sdk/storage/storage-file-share/README.md b/sdk/storage/storage-file-share/README.md index 3b081590bbfe..6441d4960e6a 100644 --- a/sdk/storage/storage-file-share/README.md +++ b/sdk/storage/storage-file-share/README.md @@ -63,6 +63,19 @@ This library depends on following ES features which need external polyfills load - `Symbol` - `Symbol.iterator` +#### Web Workers + +This library requires certain DOM objects to be globally available when used in the browser, which web workers do not make available by default. You will need to polyfill these to make this library work in web workers. + +For more information please refer to our [documentation for using Azure SDK for JS in Web Workers](https://aka.ms/azsdk/js/web-workers) + +This library depends on following DOM APIs which need external polyfills loaded when used in web workers: + +- [`document`](https://developer.mozilla.org/docs/Web/API/Document) +- [`DOMParser`](https://developer.mozilla.org/docs/Web/API/DOMParser) +- [`Node`](https://developer.mozilla.org/docs/Web/API/Node) +- [`XMLSerializer`](https://developer.mozilla.org/docs/Web/API/XMLSerializer) + #### Differences between Node.js and browsers There are differences between Node.js and browsers runtime. When getting started with this library, pay attention to APIs or classes marked with _"ONLY AVAILABLE IN NODE.JS RUNTIME"_ or _"ONLY AVAILABLE IN BROWSERS"_. diff --git a/sdk/storage/storage-queue/README.md b/sdk/storage/storage-queue/README.md index 9065815317bb..69677c3dc746 100644 --- a/sdk/storage/storage-queue/README.md +++ b/sdk/storage/storage-queue/README.md @@ -63,6 +63,19 @@ This library depends on following ES features which need external polyfills load - `Symbol` - `Symbol.iterator` +#### Web Workers + +This library requires certain DOM objects to be globally available when used in the browser, which web workers do not make available by default. You will need to polyfill these to make this library work in web workers. + +For more information please refer to our [documentation for using Azure SDK for JS in Web Workers](https://aka.ms/azsdk/js/web-workers) + +This library depends on following DOM APIs which need external polyfills loaded when used in web workers: + +- [`document`](https://developer.mozilla.org/docs/Web/API/Document) +- [`DOMParser`](https://developer.mozilla.org/docs/Web/API/DOMParser) +- [`Node`](https://developer.mozilla.org/docs/Web/API/Node) +- [`XMLSerializer`](https://developer.mozilla.org/docs/Web/API/XMLSerializer) + #### Differences between Node.js and browsers There are differences between Node.js and browsers runtime. When getting started with this library, pay attention to APIs or classes marked with _"ONLY AVAILABLE IN NODE.JS RUNTIME"_ or _"ONLY AVAILABLE IN BROWSERS"_.