From b93ed45521c8fc5f172279507f1042ebeab5fef0 Mon Sep 17 00:00:00 2001
From: ztimson <zaktimson@gmail.com>
Date: Mon, 7 Oct 2024 15:40:14 -0400
Subject: [PATCH] Renamed sleepUntil to sleepWhile, it was misleading

---
 package-lock.json | 4 ++--
 package.json      | 2 +-
 src/time.ts       | 4 ++--
 3 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/package-lock.json b/package-lock.json
index 517dc51..cdbfef5 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
 {
 	"name": "@ztimson/utils",
-	"version": "0.17.2",
+	"version": "0.18.0",
 	"lockfileVersion": 3,
 	"requires": true,
 	"packages": {
 		"": {
 			"name": "@ztimson/utils",
-			"version": "0.17.2",
+			"version": "0.18.0",
 			"license": "MIT",
 			"dependencies": {
 				"var-persist": "^1.0.1"
diff --git a/package.json b/package.json
index 33cbddd..a363440 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "@ztimson/utils",
-	"version": "0.17.2",
+	"version": "0.18.0",
 	"description": "Utility library",
 	"author": "Zak Timson",
 	"license": "MIT",
diff --git a/src/time.ts b/src/time.ts
index 16d8cd9..2f7188b 100644
--- a/src/time.ts
+++ b/src/time.ts
@@ -36,14 +36,14 @@ export function sleep(ms: number): Promise<void> {
  * ```js
  * let loading = true;
  * setTimeout(() => wait = false, 1000);
- * await sleepUntil(() => loading); // Won't continue until loading flag is false
+ * await sleepWhile(() => loading); // Won't continue until loading flag is false
  * ```
  *
  * @param {() => boolean | Promise<boolean>} fn Return true to continue
  * @param {number} checkInterval Run function ever x milliseconds
  * @return {Promise<void>} Callback when sleep is over
  */
-export async function sleepUntil(fn : () => boolean | Promise<boolean>, checkInterval = 100): Promise<void> {
+export async function sleepWhile(fn : () => boolean | Promise<boolean>, checkInterval = 100): Promise<void> {
 	while(await fn()) await sleep(checkInterval);
 }