@cloudflare/containers 0.0.27 → 0.0.29

package/dist/lib/utils.js

@@ -1,5 +1,5 @@
 /**
- * Get a random container instances across N instances
+ * Get a random container instances across N instances. This is useful for load balancing.
  * @param binding The Container's Durable Object binding
  * @param instances Number of instances to load balance across
  * @returns A promise resolving to a container stub ready to handle requests
@@ -23,15 +23,15 @@ export async function loadBalance(binding, instances = 3) {
     console.warn('loadBalance is deprecated, please use getRandom instead. This will be removed in a future version.');
     return getRandom(binding, instances);
 }
+export const singletonContainerId = 'cf-singleton-container';
 /**
  * Get a container stub
  * @param binding The Container's Durable Object binding
  * @param name The name of the instance to get, uses 'cf-singleton-container' by default
  * @returns A container stub ready to handle requests
  */
-export const singletonContainerId = 'cf-singleton-container';
-export function getContainer(binding, name) {
-    const objectId = binding.idFromName(name ?? singletonContainerId);
+export function getContainer(binding, name = singletonContainerId) {
+    const objectId = binding.idFromName(name);
     return binding.get(objectId);
 }
 /**

package/dist/lib/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/lib/utils.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,OAAkC,EAClC,YAAoB,CAAC;IAErB,qDAAqD;IACrD,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC,QAAQ,EAAE,CAAC;IAE5D,gDAAgD;IAChD,wEAAwE;IACxE,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IAEtD,4CAA4C;IAC5C,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AAC/B,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,OAAkC,EAClC,YAAoB,CAAC;IAErB,OAAO,CAAC,IAAI,CACV,oGAAoG,CACrG,CAAC;IACF,OAAO,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;AACvC,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,wBAAwB,CAAC;AAC7D,MAAM,UAAU,YAAY,CAC1B,OAAkC,EAClC,IAAa;IAEb,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,IAAI,oBAAoB,CAAC,CAAC;IAClE,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AAC/B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,OAAgB,EAAE,IAAY;IACvD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7C,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;IACzD,OAAO,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;AAC3C,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/lib/utils.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,OAAkC,EAClC,YAAoB,CAAC;IAErB,qDAAqD;IACrD,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC,QAAQ,EAAE,CAAC;IAE5D,gDAAgD;IAChD,wEAAwE;IACxE,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IAEtD,4CAA4C;IAC5C,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AAC/B,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,OAAkC,EAClC,YAAoB,CAAC;IAErB,OAAO,CAAC,IAAI,CACV,oGAAoG,CACrG,CAAC;IACF,OAAO,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;AACvC,CAAC;AAED,MAAM,CAAC,MAAM,oBAAoB,GAAG,wBAAwB,CAAC;AAC7D;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAC1B,OAAkC,EAClC,IAAI,GAAG,oBAAoB;IAE3B,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC1C,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AAC/B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,OAAgB,EAAE,IAAY;IACvD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7C,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;IACzD,OAAO,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;AAC3C,CAAC"}

package/dist/types/index.d.ts

@@ -45,11 +45,34 @@ export interface ContainerStartConfigOptions {
     /** Whether to enable internet access for the container */
     enableInternet?: boolean;
 }
-export interface WaitOptions {
+export interface StartAndWaitForPortsOptions {
+    startOptions?: ContainerStartConfigOptions;
+    ports?: number | number[];
+    cancellationOptions?: CancellationOptions;
+}
+/** cancellationOptions for startAndWaitForPorts()  */
+export interface CancellationOptions {
+    /** abort signal, use to abort startAndWaitForPorts manually. */
     abort?: AbortSignal;
-    retries: number;
-    waitInterval: number;
+    /** max time to get container instance and start it (application inside may not be ready), in milliseconds */
+    instanceGetTimeoutMS?: number;
+    /** max time to wait for application to be listening at all specified ports, in milliseconds. */
+    portReadyTimeoutMS?: number;
+    /** time to wait between polling, in milliseconds */
+    waitInterval?: number;
+}
+/**
+ * Options for waitForPort()
+ */
+export interface WaitOptions {
+    /** The port number to check for readiness */
     portToCheck: number;
+    /** Optional AbortSignal, use this to abort waiting for ports */
+    signal?: AbortSignal;
+    /** Number of attempts to wait for port to be ready */
+    retries?: number;
+    /** Time to wait in between polling port for readiness, in milliseconds */
+    waitInterval?: number;
 }
 /**
  * Represents a scheduled task within a Container

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudflare/containers",
-  "version": "0.0.27",
+  "version": "0.0.29",
   "description": "Helper class for container-enabled Durable Objects",
   "repository": {
     "type": "git",
@@ -11,8 +11,7 @@
     "typecheck": "tsc --noEmit",
     "lint": "eslint src --ext .ts,.tsx --config .eslintrc.js",
     "format": "prettier --write \"src/**/*.ts\"",
-    "test": "jest",
-    "test:watch": "jest --watch"
+    "test": "set -e; for fixture in examples/*/; do if [ -d \"$fixture/test\" ] && [ -f \"$fixture/package.json\" ]; then cd \"$fixture\"; npm install; npm run test; cd - > /dev/null; fi; done"
   },
   "exports": {
     ".": {
@@ -44,7 +43,8 @@
     "prettier": "^3.5.3",
     "ts-jest": "^29.3.2",
     "tsup": "^8.0.2",
-    "typescript": "latest"
+    "typescript": "latest",
+    "vitest": "^1.0.0"
   },
   "publishConfig": {
     "access": "public"