From 82dfb8d882b2dbb76738428c9a22ebf0f0bc5e50 Mon Sep 17 00:00:00 2001
From: Linden <65407488+thelindat@users.noreply.github.com>
Date: Fri, 2 Feb 2024 13:45:01 +1100
Subject: [PATCH] fix(waitFor): type corrections

---
 imports/waitFor/shared.lua | 6 +++---
 package/shared/index.ts    | 2 +-
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/imports/waitFor/shared.lua b/imports/waitFor/shared.lua
index 460697a..0da2896 100644
--- a/imports/waitFor/shared.lua
+++ b/imports/waitFor/shared.lua
@@ -1,9 +1,9 @@
 ---Yields the current thread until a non-nil value is returned by the function.
 ---@generic T
----@param cb fun(): T?
+---@param cb fun(): T
 ---@param errMessage string?
----@param timeout number? Error out after `~x` ms. Defaults to 1000, unless set to `false`.
----@return T?
+---@param timeout? number | false Error out after `~x` ms. Defaults to 1000, unless set to `false`.
+---@return T
 ---@async
 function lib.waitFor(cb, errMessage, timeout)
     local value = cb()
diff --git a/package/shared/index.ts b/package/shared/index.ts
index 2235456..5e83883 100644
--- a/package/shared/index.ts
+++ b/package/shared/index.ts
@@ -15,7 +15,7 @@ export function sleep(ms: number) {
  * Creates a promise that will be resolved once any value is returned by the function (including null).
  * @param {number?} timeout Error out after `~x` ms. Defaults to 1000, unless set to `false`.
  */
-export async function waitFor<T>(cb: () => T, errMessage?: string, timeout?: number): Promise<T> {
+export async function waitFor<T>(cb: () => T, errMessage?: string, timeout?: number | false): Promise<T> {
   let value = await cb();
 
   if (value !== undefined) return value;