We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent dad6c95 commit 0f92ba5Copy full SHA for 0f92ba5
packages/e2e-tests/test/test-shell.ts
@@ -49,7 +49,11 @@ export class TestShell {
49
50
/**
51
* Starts a test shell.
52
- * @private Use the {@link Mocha.Context.startTestShell} hook instead
+ *
53
+ * Beware that the caller is responsible for calling {@link TestShell.kill} (and potentially {@link TestShell.waitForExit}).
54
55
+ * Consider calling the `startTestShell` function on a {@link Mocha.Context} instead, as that manages the lifetime the shell
56
+ * and ensures it gets killed eventually.
57
*/
58
static start(options: TestShellOptions = { args: [] }): TestShell {
59
let shellProcess: ChildProcessWithoutNullStreams;
0 commit comments