@naturalcycles/js-lib 14.200.0 → 14.201.0

package/dist/abort.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Like AbortSignal, but it can "abort itself" via the `.abort()` method.
+ *
+ * Similar to how DeferredPromise is both a Promise and has `.resolve()` and `.reject()` methods.
+ *
+ * This is to simplify the AbortController/AbortSignal usage.
+ *
+ * Before this - you need to keep track of 2 things: AbortController and AbortSignal.
+ *
+ * After - you are good with only AbortableSignal, which can do both.
+ * And it's compatible with AbortSignal (because it extends it).
+ *
+ * @experimental
+ */
+export interface AbortableSignal extends AbortSignal {
+    abort: AbortController['abort'];
+}
+/**
+ * Creates AbortableSignal,
+ * which is like AbortSignal, but can "abort itself" with `.abort()` method.
+ *
+ * @experimental
+ */
+export declare function createAbortableSignal(): AbortableSignal;

package/dist/abort.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAbortableSignal = void 0;
+/**
+ * Creates AbortableSignal,
+ * which is like AbortSignal, but can "abort itself" with `.abort()` method.
+ *
+ * @experimental
+ */
+function createAbortableSignal() {
+    const ac = new AbortController();
+    return Object.assign(ac.signal, {
+        abort: ac.abort.bind(ac),
+    });
+}
+exports.createAbortableSignal = createAbortableSignal;

package/dist/index.d.ts

@@ -81,6 +81,7 @@ export * from './env/buildInfo';
 export * from './form.util';
 export * from './semver';
 export * from './web';
+export * from './abort';
 export * from './polyfill';
 export * from './zod/zod.util';
 export * from './zod/zod.shared.schemas';

package/dist/index.js

@@ -85,6 +85,7 @@ tslib_1.__exportStar(require("./env/buildInfo"), exports);
 tslib_1.__exportStar(require("./form.util"), exports);
 tslib_1.__exportStar(require("./semver"), exports);
 tslib_1.__exportStar(require("./web"), exports);
+tslib_1.__exportStar(require("./abort"), exports);
 tslib_1.__exportStar(require("./polyfill"), exports);
 tslib_1.__exportStar(require("./zod/zod.util"), exports);
 tslib_1.__exportStar(require("./zod/zod.shared.schemas"), exports);

package/dist-esm/abort.js

@@ -0,0 +1,12 @@
+/**
+ * Creates AbortableSignal,
+ * which is like AbortSignal, but can "abort itself" with `.abort()` method.
+ *
+ * @experimental
+ */
+export function createAbortableSignal() {
+    const ac = new AbortController();
+    return Object.assign(ac.signal, {
+        abort: ac.abort.bind(ac),
+    });
+}

package/dist-esm/index.js

@@ -81,6 +81,7 @@ export * from './env/buildInfo';
 export * from './form.util';
 export * from './semver';
 export * from './web';
+export * from './abort';
 export * from './polyfill';
 export * from './zod/zod.util';
 export * from './zod/zod.shared.schemas';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/js-lib",
-  "version": "14.200.0",
+  "version": "14.201.0",
   "scripts": {
     "prepare": "husky install",
     "build-prod": "build-prod-esm-cjs",

package/src/abort.ts

@@ -0,0 +1,30 @@
+/**
+ * Like AbortSignal, but it can "abort itself" via the `.abort()` method.
+ *
+ * Similar to how DeferredPromise is both a Promise and has `.resolve()` and `.reject()` methods.
+ *
+ * This is to simplify the AbortController/AbortSignal usage.
+ *
+ * Before this - you need to keep track of 2 things: AbortController and AbortSignal.
+ *
+ * After - you are good with only AbortableSignal, which can do both.
+ * And it's compatible with AbortSignal (because it extends it).
+ *
+ * @experimental
+ */
+export interface AbortableSignal extends AbortSignal {
+  abort: AbortController['abort']
+}
+
+/**
+ * Creates AbortableSignal,
+ * which is like AbortSignal, but can "abort itself" with `.abort()` method.
+ *
+ * @experimental
+ */
+export function createAbortableSignal(): AbortableSignal {
+  const ac = new AbortController()
+  return Object.assign(ac.signal, {
+    abort: ac.abort.bind(ac),
+  })
+}

package/src/index.ts

@@ -81,6 +81,7 @@ export * from './env/buildInfo'
 export * from './form.util'
 export * from './semver'
 export * from './web'
+export * from './abort'
 export * from './polyfill'
 export * from './zod/zod.util'
 export * from './zod/zod.shared.schemas'