extra-react-hooks 0.8.4 → 0.8.5

package/README.md

@@ -51,7 +51,7 @@ function useMount(effect: EffectCallback): void
 
 ### useMountAsync
 ```ts
-function useMountAsync(effect: (signal: AbortSignal) => Promise<void>): void
+function useMountAsync(effect: (signal: AbortSignal) => PromiseLike<void>): void
 ```
 
 ### useUnmount
@@ -62,7 +62,7 @@ function useUnmount(effect: () => void): void
 ### useEffectAsync
 ```ts
 function useEffectAsync(
-  effect: (signal: AbortSignal) => Promise<void>
+  effect: (signal: AbortSignal) => PromiseLike<void>
 , deps?: React.DependencyList
 ): void
 ```
@@ -178,6 +178,14 @@ function useIIFE(
 
 [If you don't need an effect]: https://react.dev/learn/you-might-not-need-an-effect
 
+### useIIFEAsync
+```ts
+function useIIFEAsync(
+  iife: (signal: AbortSignal) => PromiseLike<void>
+, deps?: React.DependencyList
+): void
+```
+
 ### useMemoWithCleanup
 ```ts
 function useMemoWithCleanup<T>(

package/lib/index.d.ts

@@ -18,6 +18,7 @@ export * from './use-step.js';
 export * from './use-force-update.js';
 export * from './use-finite-state-machine.js';
 export * from './use-iife.js';
+export * from './use-iife-async.js';
 export * from './use-memo-with-cleanup.js';
 export * from './use-get-set.js';
 export * from './use-isomorphic-layout-effect.js';

package/lib/index.js

@@ -18,6 +18,7 @@ export * from './use-step.js';
 export * from './use-force-update.js';
 export * from './use-finite-state-machine.js';
 export * from './use-iife.js';
+export * from './use-iife-async.js';
 export * from './use-memo-with-cleanup.js';
 export * from './use-get-set.js';
 export * from './use-isomorphic-layout-effect.js';

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA;AAClC,cAAc,qBAAqB,CAAA;AACnC,cAAc,0BAA0B,CAAA;AACxC,cAAc,yBAAyB,CAAA;AACvC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,sBAAsB,CAAA;AACpC,cAAc,kBAAkB,CAAA;AAChC,cAAc,uBAAuB,CAAA;AACrC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,wBAAwB,CAAA;AACtC,cAAc,2BAA2B,CAAA;AACzC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,sBAAsB,CAAA;AACpC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,0BAA0B,CAAA;AACxC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,eAAe,CAAA;AAC7B,cAAc,uBAAuB,CAAA;AACrC,cAAc,+BAA+B,CAAA;AAC7C,cAAc,eAAe,CAAA;AAC7B,cAAc,4BAA4B,CAAA;AAC1C,cAAc,kBAAkB,CAAA;AAChC,cAAc,mCAAmC,CAAA;AACjD,cAAc,mBAAmB,CAAA;AACjC,cAAc,uBAAuB,CAAA;AACrC,cAAc,sBAAsB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA;AAClC,cAAc,qBAAqB,CAAA;AACnC,cAAc,0BAA0B,CAAA;AACxC,cAAc,yBAAyB,CAAA;AACvC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,sBAAsB,CAAA;AACpC,cAAc,kBAAkB,CAAA;AAChC,cAAc,uBAAuB,CAAA;AACrC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,wBAAwB,CAAA;AACtC,cAAc,2BAA2B,CAAA;AACzC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,sBAAsB,CAAA;AACpC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,0BAA0B,CAAA;AACxC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,eAAe,CAAA;AAC7B,cAAc,uBAAuB,CAAA;AACrC,cAAc,+BAA+B,CAAA;AAC7C,cAAc,eAAe,CAAA;AAC7B,cAAc,qBAAqB,CAAA;AACnC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,kBAAkB,CAAA;AAChC,cAAc,mCAAmC,CAAA;AACjD,cAAc,mBAAmB,CAAA;AACjC,cAAc,uBAAuB,CAAA;AACrC,cAAc,sBAAsB,CAAA"}

package/lib/use-effect-async.d.ts

@@ -1 +1 @@
-export declare function useEffectAsync(effect: (signal: AbortSignal) => Promise<void>, deps?: React.DependencyList): void;
+export declare function useEffectAsync(effect: (signal: AbortSignal) => PromiseLike<void>, deps?: React.DependencyList): void;

package/lib/use-effect-async.js.map

@@ -1 +1 @@
-{"version":3,"file":"use-effect-async.js","sourceRoot":"","sources":["../src/use-effect-async.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AACjC,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAA;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAEhD,MAAM,kBAAmB,SAAQ,WAAW;CAAG;AAE/C,MAAM,UAAU,cAAc,CAC5B,MAA8C,EAC9C,IAA2B;IAE3B,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAA;QAExC,EAAE,CAAC,KAAK,IAAI,EAAE;YACZ,IAAI,CAAC;gBACH,UAAU,CAAC,MAAM,CAAC,cAAc,EAAE,CAAA;gBAElC,MAAM,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;YACjC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,GAAG,YAAY,kBAAkB,EAAE,CAAC;oBACtC,IAAI,EAAE,CAAA;gBACR,CAAC;qBAAM,CAAC;oBACN,MAAM,GAAG,CAAA;gBACX,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,OAAO,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,kBAAkB,EAAE,CAAC,CAAA;IACzD,CAAC,EAAE,IAAI,CAAC,CAAA;AACV,CAAC"}
+{"version":3,"file":"use-effect-async.js","sourceRoot":"","sources":["../src/use-effect-async.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AACjC,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAA;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAEhD,MAAM,kBAAmB,SAAQ,WAAW;CAAG;AAE/C,MAAM,UAAU,cAAc,CAC5B,MAAkD,EAClD,IAA2B;IAE3B,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAA;QAExC,EAAE,CAAC,KAAK,IAAI,EAAE;YACZ,IAAI,CAAC;gBACH,UAAU,CAAC,MAAM,CAAC,cAAc,EAAE,CAAA;gBAElC,MAAM,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;YACjC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,GAAG,YAAY,kBAAkB,EAAE,CAAC;oBACtC,IAAI,EAAE,CAAA;gBACR,CAAC;qBAAM,CAAC;oBACN,MAAM,GAAG,CAAA;gBACX,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,OAAO,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,kBAAkB,EAAE,CAAC,CAAA;IACzD,CAAC,EAAE,IAAI,CAAC,CAAA;AACV,CAAC"}

package/lib/use-iife-async.d.ts

@@ -0,0 +1 @@
+export declare function useIIFEAsync(iife: (signal: AbortSignal) => PromiseLike<void>, deps?: React.DependencyList): void;

package/lib/use-iife-async.js

@@ -0,0 +1,25 @@
+import { CustomError, go, pass } from '@blackglory/prelude';
+import { useIIFE } from './use-iife.js';
+class InternalAbortError extends CustomError {
+}
+export function useIIFEAsync(iife, deps) {
+    useIIFE(() => {
+        const controller = new AbortController();
+        go(async () => {
+            try {
+                controller.signal.throwIfAborted();
+                await iife(controller.signal);
+            }
+            catch (err) {
+                if (err instanceof InternalAbortError) {
+                    pass();
+                }
+                else {
+                    throw err;
+                }
+            }
+        });
+        return () => controller.abort(new InternalAbortError());
+    }, deps);
+}
+//# sourceMappingURL=use-iife-async.js.map

package/lib/use-iife-async.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-iife-async.js","sourceRoot":"","sources":["../src/use-iife-async.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAA;AAC3D,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAEvC,MAAM,kBAAmB,SAAQ,WAAW;CAAG;AAE/C,MAAM,UAAU,YAAY,CAC1B,IAAgD,EAChD,IAA2B;IAE3B,OAAO,CAAC,GAAG,EAAE;QACX,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAA;QAExC,EAAE,CAAC,KAAK,IAAI,EAAE;YACZ,IAAI,CAAC;gBACH,UAAU,CAAC,MAAM,CAAC,cAAc,EAAE,CAAA;gBAElC,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;YAC/B,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,GAAG,YAAY,kBAAkB,EAAE,CAAC;oBACtC,IAAI,EAAE,CAAA;gBACR,CAAC;qBAAM,CAAC;oBACN,MAAM,GAAG,CAAA;gBACX,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,OAAO,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,kBAAkB,EAAE,CAAC,CAAA;IACzD,CAAC,EAAE,IAAI,CAAC,CAAA;AACV,CAAC"}

package/lib/use-mount-async.d.ts

@@ -1 +1 @@
-export declare function useMountAsync(effect: (signal: AbortSignal) => Promise<void>): void;
+export declare function useMountAsync(effect: (signal: AbortSignal) => PromiseLike<void>): void;

package/lib/use-mount-async.js.map

@@ -1 +1 @@
-{"version":3,"file":"use-mount-async.js","sourceRoot":"","sources":["../src/use-mount-async.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAEtD,MAAM,UAAU,aAAa,CAAC,MAA8C;IAC1E,cAAc,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;AAC5B,CAAC"}
+{"version":3,"file":"use-mount-async.js","sourceRoot":"","sources":["../src/use-mount-async.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAEtD,MAAM,UAAU,aAAa,CAAC,MAAkD;IAC9E,cAAc,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;AAC5B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "extra-react-hooks",
-  "version": "0.8.4",
+  "version": "0.8.5",
   "description": "",
   "keywords": [],
   "files": [

package/src/index.ts

@@ -18,6 +18,7 @@ export * from './use-step.js'
 export * from './use-force-update.js'
 export * from './use-finite-state-machine.js'
 export * from './use-iife.js'
+export * from './use-iife-async.js'
 export * from './use-memo-with-cleanup.js'
 export * from './use-get-set.js'
 export * from './use-isomorphic-layout-effect.js'

package/src/use-effect-async.ts

@@ -6,7 +6,7 @@ import { CustomError } from '@blackglory/errors'
 class InternalAbortError extends CustomError {}
 
 export function useEffectAsync(
-  effect: (signal: AbortSignal) => Promise<void>
+  effect: (signal: AbortSignal) => PromiseLike<void>
 , deps?: React.DependencyList
 ): void {
   useEffect(() => {

package/src/use-iife-async.ts

@@ -0,0 +1,29 @@
+import { CustomError, go, pass } from '@blackglory/prelude'
+import { useIIFE } from './use-iife.js'
+
+class InternalAbortError extends CustomError {}
+
+export function useIIFEAsync(
+  iife: (signal: AbortSignal) => PromiseLike<void>
+, deps?: React.DependencyList
+): void {
+  useIIFE(() => {
+    const controller = new AbortController()
+
+    go(async () => {
+      try {
+        controller.signal.throwIfAborted()
+
+        await iife(controller.signal)
+      } catch (err) {
+        if (err instanceof InternalAbortError) {
+          pass()
+        } else {
+          throw err
+        }
+      }
+    })
+
+    return () => controller.abort(new InternalAbortError())
+  }, deps)
+}

package/src/use-mount-async.ts

@@ -1,5 +1,5 @@
 import { useEffectAsync } from './use-effect-async.js'
 
-export function useMountAsync(effect: (signal: AbortSignal) => Promise<void>): void {
+export function useMountAsync(effect: (signal: AbortSignal) => PromiseLike<void>): void {
   useEffectAsync(effect, [])
 }