@azure/core-amqp - npm Package Compare versions

Comparing version 1.0.2-dev.20200213.1 to 1.0.2-dev.20200215.1

CHANGELOG.md

@@ -5,2 +5,3 @@ # Release History
 
+- Exports `WebSocketOptions` interface to configure the channelling of the AMQP connection over Web Sockets. [PR 7368](https://github.com/Azure/azure-sdk-for-js/pull/7368)
 
@@ -28,4 +29,2 @@ ## 1.0.1 (2020-02-06)
 
-- Treat ETIMEOUT error from dns.resolve as network disconnected.
-
 ## 1.0.0-preview.5 (2019-10-29)
@@ -32,0 +31,0 @@

package.json

 {
   "name": "@azure/core-amqp",
   "sdk-type": "client",
-  "version": "1.0.2-dev.20200213.1",
+  "version": "1.0.2-dev.20200215.1",
   "description": "Common library for amqp based azure sdks like @azure/event-hubs.",
@@ -6,0 +6,0 @@ "author": "Microsoft Corporation",

README.md

@@ -260,3 +260,3 @@ # Azure Core AMQP client library for AMQP operations
 
-If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/tree/16fdb6e2d6e9ec1490dd4539ca994f5c72981bd3/CONTRIBUTING.md) to learn more about how to build and test the code.
+If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/tree/82ff70db87dfadaf8a1b2b32c23d9548d0d0fd13/CONTRIBUTING.md) to learn more about how to build and test the code.
 
@@ -263,0 +263,0 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).

src/index.ts

@@ -62,4 +62,5 @@ // Copyright (c) Microsoft Corporation. All rights reserved.
   AsyncLock,
-  isNode
+  isNode,
+  WebSocketOptions
 } from "./util/utils";
 export { logger } from "./log";

src/util/utils.ts

@@ -6,2 +6,3 @@ // Copyright (c) Microsoft Corporation. All rights reserved.
 import { AbortSignalLike, AbortError } from "@azure/abort-controller";
+import { WebSocketImpl } from "rhea-promise";
 
@@ -32,3 +33,26 @@ export { AsyncLock };
 }
+
 /**
+ * Options to configure the channelling of the AMQP connection over Web Sockets.
+ */
+export interface WebSocketOptions {
+  /**
+   * @property
+   * The WebSocket constructor used to create an AMQP connection over a WebSocket.
+   * This option should be provided in the below scenarios:
+   * - The TCP port 5671 which is that is used by the AMQP connection to Event Hubs is blocked in your environment.
+   * - Your application needs to be run behind a proxy server.
+   * - Your application needs to run in the browser and you want to provide your own choice of Websocket implementation
+   *   instead of the built-in WebSocket in the browser.
+   */
+  webSocket?: WebSocketImpl;
+  /**
+   * @property
+   * Options to be passed to the WebSocket constructor when the underlying `rhea` library instantiates
+   * the WebSocket.
+   */
+  webSocketConstructorOptions?: any;
+}
+
+/**
  * A constant that indicates whether the environment is node.js or browser based.
@@ -35,0 +59,0 @@ */

typings/src/index.d.ts

@@ -20,4 +20,4 @@ /// <reference lib="es2015" />
 export { MessagingError, ErrorNameConditionMapper, ConditionStatusMapper, ConditionErrorNameMapper, translate, retryableErrors, isSystemError, SystemErrorConditionMapper } from "./errors";
-export { delay, Timeout, EventHubConnectionStringModel, executePromisesSequentially, parseConnectionString, IotHubConnectionStringModel, StorageConnectionStringModel, defaultLock, Func, ParsedOutput, getNewAsyncLock, AsyncLockOptions, ServiceBusConnectionStringModel, isIotHubConnectionString, randomNumberFromInterval, AsyncLock, isNode } from "./util/utils";
+export { delay, Timeout, EventHubConnectionStringModel, executePromisesSequentially, parseConnectionString, IotHubConnectionStringModel, StorageConnectionStringModel, defaultLock, Func, ParsedOutput, getNewAsyncLock, AsyncLockOptions, ServiceBusConnectionStringModel, isIotHubConnectionString, randomNumberFromInterval, AsyncLock, isNode, WebSocketOptions } from "./util/utils";
 export { logger } from "./log";
 //# sourceMappingURL=index.d.ts.map

typings/src/util/utils.d.ts

 import AsyncLock from "async-lock";
 import { AbortSignalLike } from "@azure/abort-controller";
+import { WebSocketImpl } from "rhea-promise";
 export { AsyncLock };
@@ -28,2 +29,23 @@ /**
 /**
+ * Options to configure the channelling of the AMQP connection over Web Sockets.
+ */
+export interface WebSocketOptions {
+    /**
+     * @property
+     * The WebSocket constructor used to create an AMQP connection over a WebSocket.
+     * This option should be provided in the below scenarios:
+     * - The TCP port 5671 which is that is used by the AMQP connection to Event Hubs is blocked in your environment.
+     * - Your application needs to be run behind a proxy server.
+     * - Your application needs to run in the browser and you want to provide your own choice of Websocket implementation
+     *   instead of the built-in WebSocket in the browser.
+     */
+    webSocket?: WebSocketImpl;
+    /**
+     * @property
+     * Options to be passed to the WebSocket constructor when the underlying `rhea` library instantiates
+     * the WebSocket.
+     */
+    webSocketConstructorOptions?: any;
+}
+/**
  * A constant that indicates whether the environment is node.js or browser based.
@@ -30,0 +52,0 @@ */

No alert changes

Improved metrics

Total package byte prevSize

685944

increased by0.46%

Lines of code

9432

increased by0.48%

No dependency changes