Deprecate wait in JS SDK; Add .wait() in JS SDK

e2b-dev · Oct 13, 2023 · 2d7fef0 · 2d7fef0
1 parent 9a74b7e
commit 2d7fef0
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 4 deletions.
diff --git a/packages/js-sdk/src/session/process.ts b/packages/js-sdk/src/session/process.ts
@@ -93,13 +93,20 @@ export class ProcessOutput {
  * A process running in the environment.
  */
 export class Process {
+  /**
+   * @deprecated use .wait() instead
+   */
+  readonly finished: Promise<ProcessOutput>
+
   constructor(
     readonly processID: string,
     private readonly session: SessionConnection,
     private readonly triggerExit: () => void,
-    readonly finished: Promise<ProcessOutput>,
+    finished: Promise<ProcessOutput>,
     readonly output: ProcessOutput,
-  ) {}
+  ) {
+    this.finished = finished
+  }
 
   /**
    * Kills the process.
@@ -113,6 +120,13 @@ export class Process {
     }
   }
 
+  /**
+   * Waits for the process to finish.
+   */
+  async wait(): Promise<ProcessOutput> {
+    return this.finished
+  }
+
   /**
    * Sends data to the process stdin.
    *

diff --git a/packages/js-sdk/src/session/terminal.ts b/packages/js-sdk/src/session/terminal.ts
@@ -17,15 +17,23 @@ export class TerminalOutput {
 
 /**
  * A terminal session running in the environment.
+ *
  */
 export class Terminal {
+  /**
+   * @deprecated use .wait() instead
+   */
+  readonly finished: Promise<TerminalOutput>
+
   constructor(
     readonly terminalID: string,
     private readonly session: SessionConnection,
     private readonly triggerExit: () => void,
-    readonly finished: Promise<TerminalOutput>,
+    finished: Promise<TerminalOutput>,
     readonly output: TerminalOutput,
-  ) {}
+  ) {
+    this.finished = finished
+  }
 
   get data() {
     return this.output.data
@@ -44,6 +52,13 @@ export class Terminal {
     }
   }
 
+  /**
+   * Waits for the terminal to finish.
+   */
+  async wait(): Promise<TerminalOutput> {
+    return this.finished
+  }
+
   /**
    * Sends data to the terminal standard input.
    *