From 0f87f85f8bea23679ac58757b55ecec7b089c62e Mon Sep 17 00:00:00 2001
From: Vladimir Sheremet <sleuths.slews0s@icloud.com>
Date: Fri, 17 May 2024 18:56:53 +0200
Subject: [PATCH] docs: add `resolves` property

---
 README.md | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 656ad02..58c006e 100644
--- a/README.md
+++ b/README.md
@@ -59,7 +59,7 @@ console.log(spied.calls) // []
 console.log(spied.returns) // []
 ```
 
-Since 3.0.0, tinyspy doesn't unwrap the Promise anymore, so you need to await it manually:
+Since 3.0, tinyspy doesn't unwrap the Promise in `returns` anymore, so you need to await it manually:
 
 ```js
 const spied = spy(async (n) => n + '!')
@@ -67,7 +67,7 @@ const spied = spy(async (n) => n + '!')
 const promise = spied('a')
 
 console.log(spied.called) // true
-console.log(spied.returns) // [Promise<'a!'>]
+console.log(spied.returns) // ['ok', Promise<'a!'>]
 
 await promise
 
@@ -79,6 +79,21 @@ console.log(await spied.returns[0]) // 'a!'
 > [!WARNING]
 > This also means the function that returned a Promise will always have result type `'ok'` even if the Promise rejected
 
+Tinyspy 3.0 still exposes resolved values on `resolves` property:
+
+```js
+const spied = spy(async (n) => n + '!')
+
+const promise = spied('a')
+
+console.log(spied.called) // true
+console.log(spied.resolves) // [] <- not resolved yet
+
+await promise
+
+console.log(spied.resolves) // ['ok', 'a!']
+```
+
 ### spyOn
 
 > All `spy` methods are available on `spyOn`.