docs: add more doc to resultify.promise

yifanwww · Sep 17, 2023 · 950747d · 950747d
1 parent 887181f
commit 950747d
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -167,6 +167,9 @@ Takes a promise and returns a new promise that contains a result.
 const result = await resultify.promise(promise);
 ```
 
+Due to the limit of TypeScript,it's impossible to resultify overloaded functions perfectly that the returned functions are still overloaded.
+This function allows you to resultify the promise that the overloaded functions return.
+
 ## Write Your Own Implementation of `Result`?
 
 Although you do have the ability to do so, it's not recommended that you write your own implementation.

diff --git a/src/resultify.ts b/src/resultify.ts
@@ -10,6 +10,10 @@ type NoVoid<T> = T extends void ? undefined : T;
  * ```ts
  * const result = await resultify.promise(promise);
  * ```
+ *
+ * Due to the limit of TypeScript,it's impossible to resultify overloaded functions perfectly that
+ * the returned functions are still overloaded.
+ * This function allows you to resultify the promise that the overloaded functions return.
  */
 async function resultifyPromise<T, E>(promise: Promise<T>): Promise<Result<NoVoid<T>, E>> {
     try {