From: Cédric Exbrayat <cexbrayat@users.noreply.github.com>
Date: Mon, 2 Sep 2024 09:06:30 +0000 (+0200)
Subject: chore: document parameters of onWatcherCleanup (#11768)
X-Git-Tag: v3.5.0~18
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d427bcd71c9654a8dd05924a675f560f5334c705;p=thirdparty%2Fvuejs%2Fcore.git

chore: document parameters of onWatcherCleanup (#11768)
---

diff --git a/packages/reactivity/src/effect.ts b/packages/reactivity/src/effect.ts
index 11d8324428..a22990f672 100644
--- a/packages/reactivity/src/effect.ts
+++ b/packages/reactivity/src/effect.ts
@@ -507,7 +507,7 @@ export function resetTracking(): void {
  * The cleanup function is called right before the next effect run, or when the
  * effect is stopped.
  *
- * Throws a warning iff there is no currenct active effect. The warning can be
+ * Throws a warning if there is no current active effect. The warning can be
  * suppressed by passing `true` to the second argument.
  *
  * @param fn - the cleanup function to be registered
diff --git a/packages/reactivity/src/watch.ts b/packages/reactivity/src/watch.ts
index 9c1eea00b9..ceda454a56 100644
--- a/packages/reactivity/src/watch.ts
+++ b/packages/reactivity/src/watch.ts
@@ -95,6 +95,10 @@ export function getCurrentWatcher(): ReactiveEffect<any> | undefined {
  * associated effect re-runs.
  *
  * @param cleanupFn - The callback function to attach to the effect's cleanup.
+ * @param failSilently - if `true`, will not throw warning when called without
+ * an active effect.
+ * @param owner - The effect that this cleanup function should be attached to.
+ * By default, the current active effect.
  */
 export function onWatcherCleanup(
   cleanupFn: () => void,