From b213aeac71fd9689ae0a08245effd930e8a90356 Mon Sep 17 00:00:00 2001 From: Rich Harris Date: Fri, 24 Oct 2025 10:47:45 -0400 Subject: [PATCH] bit more detail --- packages/svelte/src/internal/client/reactivity/batch.js | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/packages/svelte/src/internal/client/reactivity/batch.js b/packages/svelte/src/internal/client/reactivity/batch.js index 6c8f24b3c9..e724279117 100644 --- a/packages/svelte/src/internal/client/reactivity/batch.js +++ b/packages/svelte/src/internal/client/reactivity/batch.js @@ -882,6 +882,10 @@ export function eager(fn) { * Frameworks like SvelteKit can use this to preload data when the user touches or * hovers over a link, making any subsequent navigation feel instantaneous. * + * The `fn` parameter is a synchronous function that modifies some state. The + * state changes will be reverted after the fork is initialised, then reapplied + * if and when the fork is eventually committed. + * * @param {() => void} fn * @returns {{ commit: () => void, discard: () => void }} */