TW: add type for prompt() being async in desktop app

TurboWarp · Jan 20, 2025 · 9be24ef · 9be24ef
1 parent 390dad5
commit 9be24ef
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/tests/test-scratch-vm-tw.ts b/tests/test-scratch-vm-tw.ts
@@ -64,3 +64,9 @@ target.extensionStorage['stretch'] = [
   }
 ];
 vm.runtime.extensionStorage['a'] = 'b';
+
+const promptResult = prompt('what is your name');
+promptResult as Promise<string>;
+promptResult as Promise<null>;
+promptResult as string;
+promptResult as null;
diff --git a/types/scratch-vm-extension.d.ts b/types/scratch-vm-extension.d.ts
@@ -15,6 +15,11 @@
  * reference error, not return undefined (TypeScript does not let us type that unfortunately)
  */
 declare const scaffolding: unknown | undefined;
+/**
+ * In desktop app, prompt() returns a Promise. Thus you should always do `await prompt(...)` which
+ * will work in all environments.
+ */
+declare function prompt(message?: string, _default?: string): string | null | Promise<string | null>;
 
 declare namespace Scratch {
   // TW