From 51ed264ca62c0b1d0cc392585576b503395a5065 Mon Sep 17 00:00:00 2001
From: Edward Gigolaev <49155506+movpushmov@users.noreply.github.com>
Date: Tue, 23 Apr 2024 19:38:16 +0300
Subject: [PATCH] docs: update for debounce & interval & time

---
 src/debounce/readme.md | 3 +++
 src/interval/readme.md | 3 +++
 src/time/readme.md     | 6 +++++-
 3 files changed, 11 insertions(+), 1 deletion(-)

diff --git a/src/debounce/readme.md b/src/debounce/readme.md
index f7253b4e..bf6a7504 100644
--- a/src/debounce/readme.md
+++ b/src/debounce/readme.md
@@ -201,6 +201,9 @@ someHappened(4);
 ### [Tests] Exposed timers API example
 
 ```ts
+/**
+ * `canceller` - is object, which contains previous timeout id and previous effect promise reject
+ */
 const timerFx = createEffect(({ canceller, timeout }: DebounceTimerFxProps) => {
   const { timeoutId, rejectPromise } = canceller;
 
diff --git a/src/interval/readme.md b/src/interval/readme.md
index d59e066c..bf0507e9 100644
--- a/src/interval/readme.md
+++ b/src/interval/readme.md
@@ -106,6 +106,9 @@ keepFresh(someQuery, {
 ### [Tests] Exposed timers API example
 
 ```ts
+/**
+ * `canceller` - is object, which contains previous timeout id and previous effect promise reject
+ */
 const timeoutFx = createEffect(({ canceller, timeout, running }: IntervalTimeoutFxProps) => {
   if (!running) {
     return Promise.reject();
diff --git a/src/time/readme.md b/src/time/readme.md
index 2f7bd1ab..7ee86e28 100644
--- a/src/time/readme.md
+++ b/src/time/readme.md
@@ -114,7 +114,11 @@ tick();
 ### [Tests] Exposed timers API example
 
 ```ts
-// you can attach() any source of time
+/**
+ * `timeReader` - is a either `Date.now` or the handler, that was provided via `getNow` in the configuration
+ *
+ * In your custom `readNowFx` you can change the way original time reader is used or call your own timer instead
+ */
 const readNowFx = createEffect<{ timeReader: () => number }, number>(({ timeReader }) => timeReader());
 
 const scope = fork({