@azure/abort-controller - npm Package Compare versions

Comparing version 2.1.3-alpha.20240924.1 to 2.1.3-alpha.20240925.5

dist/abort-controller.d.ts

@@ -7,9 +7,17 @@ /**
  * @example
- * ```ts
+ * ```ts snippet:abort_error
+ * import { AbortError } from "@azure/abort-controller";
+ *
+ * async function doAsyncWork(options: { abortSignal: AbortSignal }): Promise<void> {
+ *   if (options.abortSignal.aborted) {
+ *     throw new AbortError();
+ *   }
+ *   // do async work
+ * }
  * const controller = new AbortController();
  * controller.abort();
  * try {
- *   doAsyncWork(controller.signal)
+ *   doAsyncWork({ abortSignal: controller.signal });
  * } catch (e) {
- *   if (e.name === 'AbortError') {
+ *   if (e.name === "AbortError") {
  *     // handle abort error here.
@@ -16,0 +24,0 @@ *   }

dist/browser/AbortError.d.ts

@@ -7,9 +7,17 @@ /**
  * @example
- * ```ts
+ * ```ts snippet:abort_error
+ * import { AbortError } from "@azure/abort-controller";
+ *
+ * async function doAsyncWork(options: { abortSignal: AbortSignal }): Promise<void> {
+ *   if (options.abortSignal.aborted) {
+ *     throw new AbortError();
+ *   }
+ *   // do async work
+ * }
  * const controller = new AbortController();
  * controller.abort();
  * try {
- *   doAsyncWork(controller.signal)
+ *   doAsyncWork({ abortSignal: controller.signal });
  * } catch (e) {
- *   if (e.name === 'AbortError') {
+ *   if (e.name === "AbortError") {
  *     // handle abort error here.
@@ -16,0 +24,0 @@ *   }

dist/browser/AbortError.js

@@ -9,9 +9,17 @@ // Copyright (c) Microsoft Corporation.
  * @example
- * ```ts
+ * ```ts snippet:abort_error
+ * import { AbortError } from "@azure/abort-controller";
+ *
+ * async function doAsyncWork(options: { abortSignal: AbortSignal }): Promise<void> {
+ *   if (options.abortSignal.aborted) {
+ *     throw new AbortError();
+ *   }
+ *   // do async work
+ * }
  * const controller = new AbortController();
  * controller.abort();
  * try {
- *   doAsyncWork(controller.signal)
+ *   doAsyncWork({ abortSignal: controller.signal });
  * } catch (e) {
- *   if (e.name === 'AbortError') {
+ *   if (e.name === "AbortError") {
  *     // handle abort error here.
@@ -18,0 +26,0 @@ *   }

dist/commonjs/AbortError.d.ts

@@ -7,9 +7,17 @@ /**
  * @example
- * ```ts
+ * ```ts snippet:abort_error
+ * import { AbortError } from "@azure/abort-controller";
+ *
+ * async function doAsyncWork(options: { abortSignal: AbortSignal }): Promise<void> {
+ *   if (options.abortSignal.aborted) {
+ *     throw new AbortError();
+ *   }
+ *   // do async work
+ * }
  * const controller = new AbortController();
  * controller.abort();
  * try {
- *   doAsyncWork(controller.signal)
+ *   doAsyncWork({ abortSignal: controller.signal });
  * } catch (e) {
- *   if (e.name === 'AbortError') {
+ *   if (e.name === "AbortError") {
  *     // handle abort error here.
@@ -16,0 +24,0 @@ *   }

dist/commonjs/AbortError.js

@@ -12,9 +12,17 @@ "use strict";
  * @example
- * ```ts
+ * ```ts snippet:abort_error
+ * import { AbortError } from "@azure/abort-controller";
+ *
+ * async function doAsyncWork(options: { abortSignal: AbortSignal }): Promise<void> {
+ *   if (options.abortSignal.aborted) {
+ *     throw new AbortError();
+ *   }
+ *   // do async work
+ * }
  * const controller = new AbortController();
  * controller.abort();
  * try {
- *   doAsyncWork(controller.signal)
+ *   doAsyncWork({ abortSignal: controller.signal });
  * } catch (e) {
- *   if (e.name === 'AbortError') {
+ *   if (e.name === "AbortError") {
  *     // handle abort error here.
@@ -21,0 +29,0 @@ *   }

dist/esm/AbortError.d.ts

@@ -7,9 +7,17 @@ /**
  * @example
- * ```ts
+ * ```ts snippet:abort_error
+ * import { AbortError } from "@azure/abort-controller";
+ *
+ * async function doAsyncWork(options: { abortSignal: AbortSignal }): Promise<void> {
+ *   if (options.abortSignal.aborted) {
+ *     throw new AbortError();
+ *   }
+ *   // do async work
+ * }
  * const controller = new AbortController();
  * controller.abort();
  * try {
- *   doAsyncWork(controller.signal)
+ *   doAsyncWork({ abortSignal: controller.signal });
  * } catch (e) {
- *   if (e.name === 'AbortError') {
+ *   if (e.name === "AbortError") {
  *     // handle abort error here.
@@ -16,0 +24,0 @@ *   }

dist/esm/AbortError.js

@@ -9,9 +9,17 @@ // Copyright (c) Microsoft Corporation.
  * @example
- * ```ts
+ * ```ts snippet:abort_error
+ * import { AbortError } from "@azure/abort-controller";
+ *
+ * async function doAsyncWork(options: { abortSignal: AbortSignal }): Promise<void> {
+ *   if (options.abortSignal.aborted) {
+ *     throw new AbortError();
+ *   }
+ *   // do async work
+ * }
  * const controller = new AbortController();
  * controller.abort();
  * try {
- *   doAsyncWork(controller.signal)
+ *   doAsyncWork({ abortSignal: controller.signal });
  * } catch (e) {
- *   if (e.name === 'AbortError') {
+ *   if (e.name === "AbortError") {
  *     // handle abort error here.
@@ -18,0 +26,0 @@ *   }

dist/react-native/AbortError.d.ts

@@ -7,9 +7,17 @@ /**
  * @example
- * ```ts
+ * ```ts snippet:abort_error
+ * import { AbortError } from "@azure/abort-controller";
+ *
+ * async function doAsyncWork(options: { abortSignal: AbortSignal }): Promise<void> {
+ *   if (options.abortSignal.aborted) {
+ *     throw new AbortError();
+ *   }
+ *   // do async work
+ * }
  * const controller = new AbortController();
  * controller.abort();
  * try {
- *   doAsyncWork(controller.signal)
+ *   doAsyncWork({ abortSignal: controller.signal });
  * } catch (e) {
- *   if (e.name === 'AbortError') {
+ *   if (e.name === "AbortError") {
  *     // handle abort error here.
@@ -16,0 +24,0 @@ *   }

dist/react-native/AbortError.js

@@ -9,9 +9,17 @@ // Copyright (c) Microsoft Corporation.
  * @example
- * ```ts
+ * ```ts snippet:abort_error
+ * import { AbortError } from "@azure/abort-controller";
+ *
+ * async function doAsyncWork(options: { abortSignal: AbortSignal }): Promise<void> {
+ *   if (options.abortSignal.aborted) {
+ *     throw new AbortError();
+ *   }
+ *   // do async work
+ * }
  * const controller = new AbortController();
  * controller.abort();
  * try {
- *   doAsyncWork(controller.signal)
+ *   doAsyncWork({ abortSignal: controller.signal });
  * } catch (e) {
- *   if (e.name === 'AbortError') {
+ *   if (e.name === "AbortError") {
  *     // handle abort error here.
@@ -18,0 +26,0 @@ *   }

package.json

 {
   "name": "@azure/abort-controller",
   "sdk-type": "client",
-  "version": "2.1.3-alpha.20240924.1",
+  "version": "2.1.3-alpha.20240925.5",
   "description": "Microsoft Azure SDK for JavaScript - Aborter",
@@ -62,7 +62,7 @@ "author": "Microsoft Corporation",
     "build:test": "echo skipped. actual commands inlined in browser test scripts",
-    "build": "npm run clean && tshy && dev-tool run extract-api",
+    "build": "npm run clean && dev-tool run build-package && dev-tool run extract-api",
     "check-format": "dev-tool run vendored prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.{ts,cts,mts}\" \"test/**/*.{ts,cts,mts}\" \"*.{js,mjs,cjs,json}\"",
     "clean": "rimraf --glob dist dist-* temp types *.tgz *.log",
     "execute:samples": "echo skipped",
-    "extract-api": "tshy && dev-tool run extract-api",
+    "extract-api": "dev-tool run build-package && dev-tool run extract-api",
     "format": "dev-tool run vendored prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.{ts,cts,mts}\" \"test/**/*.{ts,cts,mts}\" \"*.{js,mjs,cjs,json}\"",
@@ -76,7 +76,8 @@ "integration-test:browser": "echo skipped",
     "test:browser": "npm run clean && npm run unit-test:browser && npm run integration-test:browser",
-    "test:node": "npm run clean && tshy && npm run unit-test:node && npm run integration-test:node",
-    "test": "npm run clean && tshy && npm run unit-test:node && dev-tool run build-test && npm run unit-test:browser && npm run integration-test",
-    "unit-test:browser": "npm run clean && tshy && dev-tool run build-test && dev-tool run test:vitest --no-test-proxy --browser",
+    "test:node": "npm run clean && dev-tool run build-package && npm run unit-test:node && npm run integration-test:node",
+    "test": "npm run clean && dev-tool run build-package && npm run unit-test:node && dev-tool run build-test && npm run unit-test:browser && npm run integration-test",
+    "unit-test:browser": "npm run clean && dev-tool run build-package && dev-tool run build-test && dev-tool run test:vitest --no-test-proxy --browser",
     "unit-test:node": "dev-tool run test:vitest --no-test-proxy",
-    "unit-test": "npm run unit-test:node && npm run unit-test:browser"
+    "unit-test": "npm run unit-test:node && npm run unit-test:browser",
+    "update-snippets": "dev-tool run update-snippets"
   },
@@ -96,3 +97,2 @@ "dependencies": {
     "rimraf": "^5.0.5",
-    "tshy": "^2.0.0",
     "typescript": "~5.6.2",
@@ -99,0 +99,0 @@ "vitest": "^2.0.5"

README.md

@@ -42,6 +42,11 @@ # Azure Abort Controller client library for JavaScript
 
-```js
+```ts snippet:basic_usage
+async function doAsyncWork(options: { abortSignal: AbortSignal }): Promise<void> {
+  if (options.abortSignal.aborted) {
+    return;
+  }
+  // do async work
+}
 const controller = new AbortController();
 doAsyncWork({ abortSignal: controller.signal });
-
 // at some point later
@@ -53,3 +58,9 @@ controller.abort();
 
-```js
+```ts snippet:basic_timeout
+async function doAsyncWork(options: { abortSignal: AbortSignal }): Promise<void> {
+  if (options.abortSignal.aborted) {
+    return;
+  }
+  // do async work
+}
 const signal = AbortSignal.timeout(1000);
@@ -56,0 +67,0 @@ doAsyncWork({ abortSignal: signal });

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

37409

increased by13.24%

Dev dependency count

11

decreased by-8.33%

Lines of code

440

increased by19.57%

Number of lines in readme file

81

increased by15.71%

No dependency changes