computesdk 1.11.1 → 1.12.0

package/dist/index.mjs

@@ -1337,13 +1337,38 @@ var Server = class {
     this.updateStatusHandler = handlers.updateStatus;
   }
   /**
-   * Start a new managed server
+   * Start a new managed server with optional supervisor settings
+   *
+   * **Restart Policies:**
+   * - `never` (default): No automatic restart on exit
+   * - `on-failure`: Restart only on non-zero exit code
+   * - `always`: Always restart on exit (including exit code 0)
+   *
+   * **Graceful Shutdown:**
+   * When stopping a server, it first sends SIGTERM and waits for `stop_timeout_ms`
+   * before sending SIGKILL if the process hasn't exited.
+   *
    * @param options - Server configuration
-   * @param options.slug - Unique server slug (URL-safe identifier)
-   * @param options.command - Command to start the server
-   * @param options.path - Working directory (optional)
-   * @param options.env_file - Path to env file (optional)
    * @returns Server info
+   *
+   * @example
+   * ```typescript
+   * // Basic server
+   * const server = await sandbox.server.start({
+   *   slug: 'web',
+   *   command: 'npm run dev',
+   *   path: '/app',
+   * });
+   *
+   * // With supervisor settings
+   * const server = await sandbox.server.start({
+   *   slug: 'api',
+   *   command: 'node server.js',
+   *   environment: { NODE_ENV: 'production' },
+   *   restart_policy: 'always',
+   *   max_restarts: 0, // unlimited
+   * });
+   * ```
    */
   async start(options) {
     const response = await this.startHandler(options);
@@ -2743,8 +2768,40 @@ API request failed (${response.status}): ${error}`
     return this.request("/servers");
   }
   /**
-   * Start a new managed server
+   * Start a new managed server with optional supervisor settings
+   *
    * @param options - Server configuration
+   * @param options.slug - Unique server identifier
+   * @param options.command - Command to start the server
+   * @param options.path - Working directory (optional)
+   * @param options.env_file - Path to .env file relative to path (optional)
+   * @param options.environment - Inline environment variables (merged with env_file if both provided)
+   * @param options.restart_policy - When to automatically restart: 'never' (default), 'on-failure', 'always'
+   * @param options.max_restarts - Maximum restart attempts, 0 = unlimited (default: 0)
+   * @param options.restart_delay_ms - Delay between restart attempts in milliseconds (default: 1000)
+   * @param options.stop_timeout_ms - Graceful shutdown timeout in milliseconds (default: 10000)
+   *
+   * @example
+   * ```typescript
+   * // Basic server
+   * await sandbox.startServer({
+   *   slug: 'web',
+   *   command: 'npm run dev',
+   *   path: '/app',
+   * });
+   *
+   * // With supervisor settings
+   * await sandbox.startServer({
+   *   slug: 'api',
+   *   command: 'node server.js',
+   *   path: '/app',
+   *   environment: { NODE_ENV: 'production', PORT: '3000' },
+   *   restart_policy: 'on-failure',
+   *   max_restarts: 5,
+   *   restart_delay_ms: 2000,
+   *   stop_timeout_ms: 5000,
+   * });
+   * ```
    */
   async startServer(options) {
     return this.request("/servers", {