@azure/core-lro - npm Package Compare versions

Comparing version 1.0.3-dev.20200813.1 to 1.0.3

CHANGELOG.md

 # Release History
 
-## 1.0.3 (Unreleased)
+## 1.0.3 (2021-01-07)
 
+- Updates the `tslib` dependency to version 2.x.
 
 ## 1.0.2 (2020-04-28)
+
 - Moved `@opentelemetry/types` to the `devDependencies`.
@@ -8,0 +10,0 @@

dist-esm/src/poller.js

@@ -95,5 +95,6 @@ // Copyright (c) Microsoft Corporation.
  */
+// eslint-disable-next-line no-use-before-define
 var Poller = /** @class */ (function () {
     /**
-     * A poller needs to be initialized by passing in at least the basic properties of the PollOperation<TState, TResult>.
+     * A poller needs to be initialized by passing in at least the basic properties of the `PollOperation<TState, TResult>`.
      *
@@ -160,3 +161,3 @@ * When writing an implementation of a Poller, this implementation needs to deal with the initialization
      *
-     * @param operation Must contain the basic properties of PollOperation<State, TResult>.
+     * @param operation - Must contain the basic properties of `PollOperation<State, TResult>`.
      */
@@ -175,7 +176,9 @@ function Poller(operation) {
         // and pullUntilDone did not have a .catch or await try/catch on it's return value.
-        this.promise.catch(function () { });
+        this.promise.catch(function () {
+            /* intentionally blank */
+        });
     }
     /**
      * @internal
-     * @ignore
+     * @hidden
      * Starts a loop that will break only if the poller is done
@@ -209,9 +212,9 @@ * or if the poller is stopped.
      * @internal
-     * @ignore
+     * @hidden
      * pollOnce does one polling, by calling to the update method of the underlying
      * poll operation to make any relevant change effective.
      *
-     * It only optionally receives an object with an abortSignal property, from @azure/abort-controller's AbortSignalLike.
+     * It only optionally receives an object with an abortSignal property, from \@azure/abort-controller's AbortSignalLike.
      *
-     * @param options Optional properties passed to the operation's update method.
+     * @param options - Optional properties passed to the operation's update method.
      */
@@ -238,2 +241,7 @@ Poller.prototype.pollOnce = function (options) {
                         if (this.isDone() && this.resolve) {
+                            // If the poller has finished polling, this means we now have a result.
+                            // However, it can be the case that TResult is instantiated to void, so
+                            // we are not expecting a result anyway. To assert that we might not
+                            // have a result eventually after finishing polling, we cast the result
+                            // to TResult.
                             this.resolve(state.result);
@@ -257,3 +265,3 @@ }
      * @internal
-     * @ignore
+     * @hidden
      * fireProgress calls the functions passed in via onProgress the method of the poller.
@@ -264,3 +272,3 @@ *
      *
-     * @param state The current operation state.
+     * @param state - The current operation state.
      */
@@ -275,3 +283,3 @@ Poller.prototype.fireProgress = function (state) {
      * @internal
-     * @ignore
+     * @hidden
      * Invokes the underlying operation's cancel method, and rejects the
@@ -303,5 +311,5 @@ * pollUntilDone promise.
      *
-     * It only optionally receives an object with an abortSignal property, from @azure/abort-controller's AbortSignalLike.
+     * It only optionally receives an object with an abortSignal property, from \@azure/abort-controller's AbortSignalLike.
      *
-     * @param options Optional properties passed to the operation's update method.
+     * @param options - Optional properties passed to the operation's update method.
      */
@@ -316,3 +324,3 @@ Poller.prototype.poll = function (options) {
             };
-            this.pollOncePromise.then(clearPollOncePromise, clearPollOncePromise);
+            this.pollOncePromise.then(clearPollOncePromise, clearPollOncePromise).catch(this.reject);
         }
@@ -374,7 +382,7 @@ return this.pollOncePromise;
      *
-     * It only optionally receives an object with an abortSignal property, from @azure/abort-controller's AbortSignalLike.
+     * It only optionally receives an object with an abortSignal property, from \@azure/abort-controller's AbortSignalLike.
      *
      * If it's called again before it finishes, it will throw an error.
      *
-     * @param options Optional properties passed to the operation's update method.
+     * @param options - Optional properties passed to the operation's update method.
      */
@@ -381,0 +389,0 @@ Poller.prototype.cancelOperation = function (options) {

dist-esm/src/pollOperation.js

 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
+export {};
 //# sourceMappingURL=pollOperation.js.map

dist/index.js

@@ -6,3 +6,3 @@ /*!
  * 
- * Azure Core LRO SDK for JavaScript - 1.0.3-dev.20200813.1
+ * Azure Core LRO SDK for JavaScript - 1.0.3
  */
@@ -105,5 +105,6 @@ 'use strict';
  */
+// eslint-disable-next-line no-use-before-define
 var Poller = /** @class */ (function () {
     /**
-     * A poller needs to be initialized by passing in at least the basic properties of the PollOperation<TState, TResult>.
+     * A poller needs to be initialized by passing in at least the basic properties of the `PollOperation<TState, TResult>`.
      *
@@ -170,3 +171,3 @@ * When writing an implementation of a Poller, this implementation needs to deal with the initialization
      *
-     * @param operation Must contain the basic properties of PollOperation<State, TResult>.
+     * @param operation - Must contain the basic properties of `PollOperation<State, TResult>`.
      */
@@ -185,7 +186,9 @@ function Poller(operation) {
         // and pullUntilDone did not have a .catch or await try/catch on it's return value.
-        this.promise.catch(function () { });
+        this.promise.catch(function () {
+            /* intentionally blank */
+        });
     }
     /**
      * @internal
-     * @ignore
+     * @hidden
      * Starts a loop that will break only if the poller is done
@@ -219,9 +222,9 @@ * or if the poller is stopped.
      * @internal
-     * @ignore
+     * @hidden
      * pollOnce does one polling, by calling to the update method of the underlying
      * poll operation to make any relevant change effective.
      *
-     * It only optionally receives an object with an abortSignal property, from @azure/abort-controller's AbortSignalLike.
+     * It only optionally receives an object with an abortSignal property, from \@azure/abort-controller's AbortSignalLike.
      *
-     * @param options Optional properties passed to the operation's update method.
+     * @param options - Optional properties passed to the operation's update method.
      */
@@ -248,2 +251,7 @@ Poller.prototype.pollOnce = function (options) {
                         if (this.isDone() && this.resolve) {
+                            // If the poller has finished polling, this means we now have a result.
+                            // However, it can be the case that TResult is instantiated to void, so
+                            // we are not expecting a result anyway. To assert that we might not
+                            // have a result eventually after finishing polling, we cast the result
+                            // to TResult.
                             this.resolve(state.result);
@@ -267,3 +275,3 @@ }
      * @internal
-     * @ignore
+     * @hidden
      * fireProgress calls the functions passed in via onProgress the method of the poller.
@@ -274,3 +282,3 @@ *
      *
-     * @param state The current operation state.
+     * @param state - The current operation state.
      */
@@ -285,3 +293,3 @@ Poller.prototype.fireProgress = function (state) {
      * @internal
-     * @ignore
+     * @hidden
      * Invokes the underlying operation's cancel method, and rejects the
@@ -313,5 +321,5 @@ * pollUntilDone promise.
      *
-     * It only optionally receives an object with an abortSignal property, from @azure/abort-controller's AbortSignalLike.
+     * It only optionally receives an object with an abortSignal property, from \@azure/abort-controller's AbortSignalLike.
      *
-     * @param options Optional properties passed to the operation's update method.
+     * @param options - Optional properties passed to the operation's update method.
      */
@@ -326,3 +334,3 @@ Poller.prototype.poll = function (options) {
             };
-            this.pollOncePromise.then(clearPollOncePromise, clearPollOncePromise);
+            this.pollOncePromise.then(clearPollOncePromise, clearPollOncePromise).catch(this.reject);
         }
@@ -384,7 +392,7 @@ return this.pollOncePromise;
      *
-     * It only optionally receives an object with an abortSignal property, from @azure/abort-controller's AbortSignalLike.
+     * It only optionally receives an object with an abortSignal property, from \@azure/abort-controller's AbortSignalLike.
      *
      * If it's called again before it finishes, it will throw an error.
      *
-     * @param options Optional properties passed to the operation's update method.
+     * @param options - Optional properties passed to the operation's update method.
      */
@@ -391,0 +399,0 @@ Poller.prototype.cancelOperation = function (options) {

package.json

 {
   "name": "@azure/core-lro",
-  "author": {
-    "name": "Microsoft Corporation",
-    "email": "[e-mail]",
-    "url": "https://github.com/Azure/azure-sdk-for-js"
-  },
+  "author": "Microsoft Corporation",
   "sdk-type": "client",
-  "version": "1.0.3-dev.20200813.1",
+  "version": "1.0.3",
   "description": "LRO Polling strtegy for the Azure SDK in TypeScript",
@@ -27,3 +23,5 @@ "tags": [
     "lro",
-    "polling"
+    "polling",
+    "azure",
+    "cloud"
   ],
@@ -35,7 +33,10 @@ "main": "./dist/index.js",
     "types/core-lro.d.ts",
+    "dist-esm/src",
     "dist/",
-    "dist-esm/",
     "README.md",
     "LICENSE"
   ],
+  "engines": {
+    "node": ">=8.0.0"
+  },
   "browser": {
@@ -46,9 +47,6 @@ "os": false,
   "license": "MIT",
-  "homepage": "https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/core-lro",
-  "repository": {
-    "type": "git",
-    "url": "[e-mail]:Azure/azure-sdk-for-js.git"
-  },
+  "homepage": "https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/core-lro/README.md",
+  "repository": "github:Azure/azure-sdk-for-js",
   "bugs": {
-    "url": "http://github.com/Azure/azure-sdk-for-js/issues"
+    "url": "https://github.com/Azure/azure-sdk-for-js/issues"
   },
@@ -86,5 +84,4 @@ "nyc": {
     "integration-test": "npm run integration-test:node && npm run integration-test:browser",
-    "lint:fix": "eslint -c ../../.eslintrc.old.json src test --ext .ts --fix --fix-type [problem,suggestion]",
-    "lint": "eslint -c ../../.eslintrc.old.json src test  --ext .ts -f html -o core-lro-lintReport.html || exit 0",
-    "lint:terminal": "eslint -c ../../.eslintrc.old.json src test --ext .ts",
+    "lint:fix": "eslint package.json api-extractor.json src test --ext .ts --fix --fix-type [problem,suggestion]",
+    "lint": "eslint package.json api-extractor.json src test  --ext .ts",
     "test:browser": "npm run build:test && npm run unit-test:browser && npm run integration-test:browser",
@@ -97,3 +94,4 @@ "test:node": "npm run build:test && npm run unit-test:node && npm run integration-test:node",
     "pack": "npm pack 2>&1",
-    "prebuild": "npm run clean"
+    "prebuild": "npm run clean",
+    "docs": "typedoc --excludePrivate --excludeNotExported --excludeExternals --mode file --out ./dist/docs ./src"
   },
@@ -103,3 +101,3 @@ "sideEffects": false,
     "@azure/abort-controller": "^1.0.0",
-    "@azure/core-http": "^1.1.6",
+    "@azure/core-http": "^1.2.0",
     "events": "^3.0.0",
@@ -109,2 +107,3 @@ "tslib": "^2.0.0"
   "devDependencies": {
+    "@azure/eslint-plugin-azure-sdk": "^3.0.0",
     "@opentelemetry/api": "^0.10.2",
@@ -119,11 +118,5 @@ "@microsoft/api-extractor": "7.7.11",
     "@types/node": "^8.0.0",
-    "@typescript-eslint/eslint-plugin": "^2.0.0",
-    "@typescript-eslint/parser": "^2.0.0",
     "assert": "^1.4.1",
     "chai": "^4.2.0",
-    "eslint": "^6.1.0",
-    "eslint-config-prettier": "^6.0.0",
-    "eslint-plugin-no-null": "^1.0.2",
-    "eslint-plugin-no-only-tests": "^2.3.0",
-    "eslint-plugin-promise": "^4.1.1",
+    "eslint": "^7.15.0",
     "karma": "^5.1.0",
@@ -152,5 +145,6 @@ "karma-chrome-launcher": "^3.0.0",
     "ts-node": "^8.3.0",
-    "typescript": "~3.9.3",
-    "uglify-js": "^3.4.9"
+    "typescript": "4.1.2",
+    "uglify-js": "^3.4.9",
+    "typedoc": "0.15.0"
   }
 }

README.md

@@ -9,3 +9,3 @@ # Azure Core LRO client library for JavaScript
 
-[Source code](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/core-lro) | [Package (npm)](https://www.npmjs.com/package/@azure/core-lro) | [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/core-lro) | [Samples](https://github.com/Azure/azure-sdk-for-js/tree/c57c09ee1c025374571b16f23a07605c3f3b623e/sdk/core/core-lro/samples)
+[Source code](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/core-lro) | [Package (npm)](https://www.npmjs.com/package/@azure/core-lro) | [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/core-lro) | [Samples](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/core-lro/samples)
 
@@ -72,3 +72,3 @@ ## Getting started
 
-Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/c57c09ee1c025374571b16f23a07605c3f3b623e/sdk/core/core-lro/samples) directory for detailed examples on how to use this library.
+Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/core-lro/samples) directory for detailed examples on how to use this library.
 
@@ -75,0 +75,0 @@ ## Contributing

types/core-lro.d.ts

@@ -86,3 +86,3 @@ import { AbortSignalLike } from '@azure/abort-controller';
     /**
-     * A poller needs to be initialized by passing in at least the basic properties of the PollOperation<TState, TResult>.
+     * A poller needs to be initialized by passing in at least the basic properties of the `PollOperation<TState, TResult>`.
      *
@@ -149,3 +149,3 @@ * When writing an implementation of a Poller, this implementation needs to deal with the initialization
      *
-     * @param operation Must contain the basic properties of PollOperation<State, TResult>.
+     * @param operation - Must contain the basic properties of `PollOperation<State, TResult>`.
      */
@@ -157,3 +157,3 @@ constructor(operation: PollOperation<TState, TResult>);
      *
-     * @azure/core-http has a simple implementation of a delay function that waits as many milliseconds as specified.
+     * \@azure/core-http has a simple implementation of a delay function that waits as many milliseconds as specified.
      * This can be used as follows:
@@ -184,5 +184,5 @@ *
      *
-     * It only optionally receives an object with an abortSignal property, from @azure/abort-controller's AbortSignalLike.
+     * It only optionally receives an object with an abortSignal property, from \@azure/abort-controller's AbortSignalLike.
      *
-     * @param options Optional properties passed to the operation's update method.
+     * @param options - Optional properties passed to the operation's update method.
      */
@@ -218,7 +218,7 @@ poll(options?: {
      *
-     * It only optionally receives an object with an abortSignal property, from @azure/abort-controller's AbortSignalLike.
+     * It only optionally receives an object with an abortSignal property, from \@azure/abort-controller's AbortSignalLike.
      *
      * If it's called again before it finishes, it will throw an error.
      *
-     * @param options Optional properties passed to the operation's update method.
+     * @param options - Optional properties passed to the operation's update method.
      */
@@ -383,7 +383,7 @@ cancelOperation(options?: {
      *
-     * It optionally receives an object with an abortSignal property, from @azure/abort-controller's AbortSignalLike.
+     * It optionally receives an object with an abortSignal property, from \@azure/abort-controller's AbortSignalLike.
      * Also optionally receives a "fireProgress" function, which, if called, is responsible for triggering the
      * poller's onProgress callbacks.
      *
-     * @param options Optional properties passed to the operation's update method.
+     * @param options - Optional properties passed to the operation's update method.
      */
@@ -397,7 +397,7 @@ update(options?: {
      *
-     * It only optionally receives an object with an abortSignal property, from @azure/abort-controller's AbortSignalLike.
+     * It only optionally receives an object with an abortSignal property, from \@azure/abort-controller's AbortSignalLike.
      *
      * It returns a promise that should be resolved with an updated version of the poller's operation.
      *
-     * @param options Optional properties passed to the operation's update method.
+     * @param options - Optional properties passed to the operation's update method.
      */
@@ -404,0 +404,0 @@ cancel(options?: {

New alerts

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Dev dependency count

39

decreased by-9.3%

Number of low quality alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

116338

decreased by-47.48%

Number of package files

13

decreased by-60.61%

Lines of code

1377

decreased by-46.38%

Number of low supply chain risk alerts

1

increased byInfinity%

Dependency changes

• Updated@azure/core-http@^1.2.0