Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

onCleanup accessible from onMount #2323

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+6 −3
Open

onCleanup accessible from onMount #2323

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0133113
Update signal.ts
GustavBW Oct 4, 2024
d6e2d7d
Update signal.ts
GustavBW Oct 4, 2024
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: 6 additions & 3 deletions packages/solid/src/reactive/signal.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -963,12 +963,15 @@ export function on<S, Next extends Prev, Prev = Next>(

/**
* Runs an effect only after initial render on mount
* @param fn an effect that should run only once on mount
* @param fn an effect that should run only once on mount. It can return a function to be run on cleanup.
*
* @description https://docs.solidjs.com/reference/lifecycle/on-mount
*/
export function onMount(fn: () => void) {
createEffect(() => untrack(fn));
export function onMount(fn: () => (void | (() => void))) {
createEffect(() => untrack(() => {
const toRunOnCleanup = fn();
if (toRunOnCleanup) onCleanup(toRunOnCleanup);
}));
}

/**
Expand Down