make unit for startup timeout more obvious (#437)

testcontainers · Feb 14, 2023 · 5a033cd · 5a033cd
1 parent ef28476
commit 5a033cd
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -793,7 +793,7 @@ const { GenericContainer } = require("testcontainers");
 
 const container = await new GenericContainer("redis")
   .withExposedPorts(6379)
-  .withStartupTimeout(120000)
+  .withStartupTimeout(120000) // wait 120s 
   .start();
 ```
 

diff --git a/src/generic-container/generic-container.ts b/src/generic-container/generic-container.ts
@@ -317,8 +317,8 @@ export class GenericContainer implements TestContainer {
     return this;
   }
 
-  public withStartupTimeout(startupTimeout: number): this {
-    this.startupTimeout = startupTimeout;
+  public withStartupTimeout(startupTimeoutMs: number): this {
+    this.startupTimeout = startupTimeoutMs;
     return this;
   }
 

diff --git a/src/test-container.ts b/src/test-container.ts
@@ -38,7 +38,7 @@ export interface TestContainer {
 
   withWaitStrategy(waitStrategy: WaitStrategy): this;
 
-  withStartupTimeout(startupTimeout: number): this;
+  withStartupTimeout(startupTimeoutMs: number): this;
 
   withNetwork(network: StartedNetwork): this;