feat: [createControledPromise] improve example

GreatAuk · Nov 9, 2024 · 3d1862d · 3d1862d
1 parent 230fce3
commit 3d1862d
Showing 1 changed file with 11 additions and 4 deletions.
diff --git a/packages/core/src/createControledPromise.ts b/packages/core/src/createControledPromise.ts
@@ -10,18 +10,25 @@ export interface ControlledPromise<T = void> extends Promise<T> {
 
 /**
  * Return a Promise with `resolve` and `reject` methods
- *
+ * @linkcode https://github.com/GreatAuk/utopia-utils/blob/main/packages/core/src/createControledPromise.ts
  * @example
  * ```
  * const promise = createControlledPromise()
- *
  * await promise
- *
  * // in anther context:
  * promise.resolve(data)
  * ```
+ *
+ * @example
+ * ```
+ * const promise = createControlledPromise()
+ *
+ * promise.then(res => console.log(res)) // => 111
+ * // in anther context:
+ * promise.resolve(111)
+ * ```
  */
-export function createControlledPromise<T>(): ControlledPromise<T> {
+export function createControlledPromise<T = void>(): ControlledPromise<T> {
   let resolve: any, reject: any
   const promise = new Promise<T>((_resolve, _reject) => {
     resolve = _resolve