Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions src/createEffectWhen/createEffectWhen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,11 @@ import type { DependencyList } from "react";
* [user, token]
* );
*
* @example — with a guard predicate for type narrowing
* const useEffectWhenReady = createEffectWhen(
* (deps): deps is ReadyDeps<typeof deps> => predicates.ready(deps)
* );
* NOTE: this bakes `predicate`'s deps shape in at creation time, so it fits a
* fixed deps shape reused across call sites. It's not a fit for the
* universal predicates like `predicates.ready`/`predicates.truthy` — those
* need to narrow a different deps tuple on every call, which is what
* `useEffectWhenReady`/`useEffectWhenTruthy` are for.
*/
export function createEffectWhen<T extends DependencyList, U extends T>(
predicate: GuardPredicate<T, U>
Expand Down
6 changes: 3 additions & 3 deletions src/useEffectWhen/useEffectWhen.types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export interface UseEffectWhenOptions<T extends DependencyList> {
}

export interface UseEffectWhenPredicates {
ready<T extends DependencyList>(deps: T): deps is ReadyDeps<T>;
truthy<T extends DependencyList>(deps: T): deps is TruthyDeps<T>;
always<T extends DependencyList>(deps: T): deps is T;
ready: <T extends DependencyList>(deps: T) => deps is ReadyDeps<T>;
truthy: <T extends DependencyList>(deps: T) => deps is TruthyDeps<T>;
always: <T extends DependencyList>(deps: T) => deps is T;
}
5 changes: 2 additions & 3 deletions src/useEffectWhenReady/useEffectWhenReady.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import { useEffectWhen } from "../useEffectWhen";
import { isReady } from "./useEffectWhenReady.utils";
import { predicates, useEffectWhen } from "../useEffectWhen";
import type { ReadyDeps, UseEffectWhenEffect, UseEffectWhenOptions } from "../useEffectWhen";
import type { DependencyList } from "react";

Expand All @@ -8,5 +7,5 @@ export function useEffectWhenReady<T extends DependencyList>(
deps: T,
options?: UseEffectWhenOptions<T>
): void {
useEffectWhen(effect, deps, isReady, options);
useEffectWhen(effect, deps, predicates.ready, options);
}
6 changes: 0 additions & 6 deletions src/useEffectWhenReady/useEffectWhenReady.utils.ts

This file was deleted.

5 changes: 2 additions & 3 deletions src/useEffectWhenTruthy/useEffectWhenTruthy.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import { useEffectWhen } from "../useEffectWhen";
import { isTruthy } from "./useEffectWhenTruthy.utils";
import { predicates, useEffectWhen } from "../useEffectWhen";
import type { TruthyDeps, UseEffectWhenEffect, UseEffectWhenOptions } from "../useEffectWhen";
import type { DependencyList } from "react";

Expand All @@ -8,5 +7,5 @@ export function useEffectWhenTruthy<T extends DependencyList>(
deps: T,
options?: UseEffectWhenOptions<T>
): void {
useEffectWhen(effect, deps, isTruthy, options);
useEffectWhen(effect, deps, predicates.truthy, options);
}
7 changes: 0 additions & 7 deletions src/useEffectWhenTruthy/useEffectWhenTruthy.utils.ts

This file was deleted.

Loading