modal 0.5.0-dev.6 → 0.5.0

package/dist/index.d.cts

@@ -4991,7 +4991,7 @@ declare class FunctionCallService {
 }
 /** Optional parameters for {@link FunctionCall#get FunctionCall.get()}. */
 type FunctionCallGetParams = {
-    timeout?: number;
+    timeoutMs?: number;
 };
 /** Optional parameters for {@link FunctionCall#cancel FunctionCall.cancel()}. */
 type FunctionCallCancelParams = {
@@ -5049,7 +5049,7 @@ interface FunctionUpdateAutoscalerParams {
     minContainers?: number;
     maxContainers?: number;
     bufferContainers?: number;
-    scaledownWindow?: number;
+    scaledownWindowMs?: number;
 }
 /** Represents a deployed Modal Function, which can be invoked remotely. */
 declare class Function_ {
@@ -5216,7 +5216,9 @@ declare class ClsService {
 }
 type ClsWithOptionsParams = {
     cpu?: number;
-    memory?: number;
+    cpuLimit?: number;
+    memoryMiB?: number;
+    memoryLimitMiB?: number;
     gpu?: string;
     env?: Record<string, string>;
     secrets?: Secret[];
@@ -5224,8 +5226,8 @@ type ClsWithOptionsParams = {
     retries?: number | Retries;
     maxContainers?: number;
     bufferContainers?: number;
-    scaledownWindow?: number;
-    timeout?: number;
+    scaledownWindowMs?: number;
+    timeoutMs?: number;
 };
 type ClsWithConcurrencyParams = {
     maxInputs: number;
@@ -5457,8 +5459,8 @@ type QueueClearParams = {
 };
 /** Optional parameters for {@link Queue#get Queue.get()}. */
 type QueueGetParams = {
-    /** How long to wait if the Queue is empty (default: indefinite). */
-    timeout?: number;
+    /** How long to wait if the Queue is empty in milliseconds (default: indefinite). */
+    timeoutMs?: number;
     /** Partition to fetch values from, uses default partition if not set. */
     partition?: string;
 };
@@ -5466,12 +5468,12 @@ type QueueGetParams = {
 type QueueGetManyParams = QueueGetParams;
 /** Optional parameters for {@link Queue#put Queue.put()}. */
 type QueuePutParams = {
-    /** How long to wait if the Queue is full (default: indefinite). */
-    timeout?: number;
+    /** How long to wait if the Queue is full in milliseconds (default: indefinite). */
+    timeoutMs?: number;
     /** Partition to add items to, uses default partition if not set. */
     partition?: string;
-    /** TTL for the partition in seconds (default: 1 day). */
-    partitionTtl?: number;
+    /** TTL for the partition in milliseconds (default: 1 day). */
+    partitionTtlMs?: number;
 };
 /** Optional parameters for {@link Queue#putMany Queue.putMany()}. */
 type QueuePutManyParams = QueuePutParams;
@@ -5484,8 +5486,8 @@ type QueueLenParams = {
 };
 /** Optional parameters for {@link Queue#iterate Queue.iterate()}. */
 type QueueIterateParams = {
-    /** How long to wait between successive items before exiting iteration (default: 0). */
-    itemPollTimeout?: number;
+    /** How long to wait between successive items before exiting iteration in milliseconds (default: 0). */
+    itemPollTimeoutMs?: number;
     /** Partition to iterate, uses default partition if not set. */
     partition?: string;
 };
@@ -5520,7 +5522,7 @@ declare class Queue {
      * Remove and return the next object from the Queue.
      *
      * By default, this will wait until at least one item is present in the Queue.
-     * If `timeout` is set, raises `QueueEmptyError` if no items are available
+     * If `timeoutMs` is set, raises `QueueEmptyError` if no items are available
      * within that timeout in milliseconds.
      */
     get(params?: QueueGetParams): Promise<any | null>;
@@ -5528,7 +5530,7 @@ declare class Queue {
      * Remove and return up to `n` objects from the Queue.
      *
      * By default, this will wait until at least one item is present in the Queue.
-     * If `timeout` is set, raises `QueueEmptyError` if no items are available
+     * If `timeoutMs` is set, raises `QueueEmptyError` if no items are available
      * within that timeout in milliseconds.
      */
     getMany(n: number, params?: QueueGetManyParams): Promise<any[]>;
@@ -5536,7 +5538,7 @@ declare class Queue {
      * Add an item to the end of the Queue.
      *
      * If the Queue is full, this will retry with exponential backoff until the
-     * provided `timeout` is reached, or indefinitely if `timeout` is not set.
+     * provided `timeoutMs` is reached, or indefinitely if `timeoutMs` is not set.
      * Raises {@link QueueFullError} if the Queue is still full after the timeout.
      */
     put(v: any, params?: QueuePutParams): Promise<void>;
@@ -5544,7 +5546,7 @@ declare class Queue {
      * Add several items to the end of the Queue.
      *
      * If the Queue is full, this will retry with exponential backoff until the
-     * provided `timeout` is reached, or indefinitely if `timeout` is not set.
+     * provided `timeoutMs` is reached, or indefinitely if `timeoutMs` is not set.
      * Raises {@link QueueFullError} if the Queue is still full after the timeout.
      */
     putMany(values: any[], params?: QueuePutManyParams): Promise<void>;
@@ -5657,14 +5659,18 @@ type StreamMode = "text" | "binary";
 type SandboxCreateParams = {
     /** Reservation of physical CPU cores for the Sandbox, can be fractional. */
     cpu?: number;
+    /** Hard limit of physical CPU cores for the Sandbox, can be fractional. */
+    cpuLimit?: number;
     /** Reservation of memory in MiB. */
-    memory?: number;
+    memoryMiB?: number;
+    /** Hard limit of memory in MiB. */
+    memoryLimitMiB?: number;
     /** GPU reservation for the Sandbox (e.g. "A100", "T4:2", "A100-80GB:4"). */
     gpu?: string;
-    /** Timeout of the Sandbox container, defaults to 10 minutes. */
-    timeout?: number;
+    /** Timeout of the Sandbox container in milliseconds, defaults to 10 minutes. */
+    timeoutMs?: number;
     /** The amount of time in milliseconds that a sandbox can be idle before being terminated. */
-    idleTimeout?: number;
+    idleTimeoutMs?: number;
     /** Working directory of the Sandbox. */
     workdir?: string;
     /**
@@ -5765,7 +5771,7 @@ type SandboxExecParams = {
     /** Working directory to run the command in. */
     workdir?: string;
     /** Timeout for the process in milliseconds. Defaults to 0 (no timeout). */
-    timeout?: number;
+    timeoutMs?: number;
     /** Environment variables to set for the command. */
     env?: Record<string, string>;
     /** {@link Secret}s to inject as environment variables for the commmand.*/
@@ -5830,16 +5836,16 @@ declare class Sandbox {
      *
      * @returns A dictionary of {@link Tunnel} objects which are keyed by the container port.
      */
-    tunnels(timeout?: number): Promise<Record<number, Tunnel>>;
+    tunnels(timeoutMs?: number): Promise<Record<number, Tunnel>>;
     /**
      * Snapshot the filesystem of the Sandbox.
      *
      * Returns an {@link Image} object which can be used to spawn a new Sandbox with the same filesystem.
      *
-     * @param timeout - Timeout for the snapshot operation in milliseconds
+     * @param timeoutMs - Timeout for the snapshot operation in milliseconds
      * @returns Promise that resolves to an {@link Image}
      */
-    snapshotFilesystem(timeout?: number): Promise<Image>;
+    snapshotFilesystem(timeoutMs?: number): Promise<Image>;
     /**
      * Check if the Sandbox has finished running.
      *
@@ -5876,7 +5882,7 @@ interface ModalClientParams {
     tokenSecret?: string;
     environment?: string;
     endpoint?: string;
-    timeout?: number;
+    timeoutMs?: number;
     maxRetries?: number;
     /** @ignore */
     cpClient?: ModalGrpcClient;
@@ -5928,7 +5934,7 @@ declare class ModalClient {
 }
 type TimeoutOptions = {
     /** Timeout for this call, interpreted as a duration in milliseconds */
-    timeout?: number;
+    timeoutMs?: number;
 };
 type RetryOptions = {
     /** Number of retries to take. */
@@ -6060,4 +6066,6 @@ declare class SandboxTimeoutError extends Error {
     constructor(message?: string);
 }
 
-export { AlreadyExistsError, App, type AppFromNameParams, AppService, type ClientOptions, CloudBucketMount, Cls, type ClsFromNameParams, ClsInstance, ClsService, type ClsWithBatchingParams, type ClsWithConcurrencyParams, type ClsWithOptionsParams, ContainerProcess, type DeleteOptions, type EphemeralOptions, FunctionCall, type FunctionCallCancelParams, type FunctionCallGetParams, FunctionCallService, type FunctionFromNameParams, FunctionService, type FunctionStats, FunctionTimeoutError, type FunctionUpdateAutoscalerParams, Function_, Image, type ImageDeleteParams, type ImageDockerfileCommandsParams, ImageService, InternalFailure, InvalidError, type LookupOptions, ModalClient, type ModalClientParams, type ModalReadStream, type ModalWriteStream, NotFoundError, type Profile, Proxy, type ProxyFromNameParams, ProxyService, Queue, type QueueClearParams, type QueueDeleteParams, QueueEmptyError, type QueueEphemeralParams, type QueueFromNameParams, QueueFullError, type QueueGetParams, type QueueIterateParams, type QueueLenParams, type QueuePutParams, QueueService, RemoteError, Retries, Sandbox, type SandboxCreateParams, type SandboxExecParams, SandboxFile, type SandboxFileMode, type SandboxFromNameParams, type SandboxListParams, SandboxService, SandboxTimeoutError, Secret, type SecretFromNameParams, type SecretFromObjectParams, SecretService, type StdioBehavior, type StreamMode, Tunnel, Volume, type VolumeEphemeralParams, type VolumeFromNameParams, VolumeService, close, initializeClient };
+declare function checkForRenamedParams(params: any, renames: Record<string, string>): void;
+
+export { AlreadyExistsError, App, type AppFromNameParams, AppService, type ClientOptions, CloudBucketMount, Cls, type ClsFromNameParams, ClsInstance, ClsService, type ClsWithBatchingParams, type ClsWithConcurrencyParams, type ClsWithOptionsParams, ContainerProcess, type DeleteOptions, type EphemeralOptions, FunctionCall, type FunctionCallCancelParams, type FunctionCallGetParams, FunctionCallService, type FunctionFromNameParams, FunctionService, type FunctionStats, FunctionTimeoutError, type FunctionUpdateAutoscalerParams, Function_, Image, type ImageDeleteParams, type ImageDockerfileCommandsParams, ImageService, InternalFailure, InvalidError, type LookupOptions, ModalClient, type ModalClientParams, type ModalReadStream, type ModalWriteStream, NotFoundError, type Profile, Proxy, type ProxyFromNameParams, ProxyService, Queue, type QueueClearParams, type QueueDeleteParams, QueueEmptyError, type QueueEphemeralParams, type QueueFromNameParams, QueueFullError, type QueueGetParams, type QueueIterateParams, type QueueLenParams, type QueuePutParams, QueueService, RemoteError, Retries, Sandbox, type SandboxCreateParams, type SandboxExecParams, SandboxFile, type SandboxFileMode, type SandboxFromNameParams, type SandboxListParams, SandboxService, SandboxTimeoutError, Secret, type SecretFromNameParams, type SecretFromObjectParams, SecretService, type StdioBehavior, type StreamMode, Tunnel, Volume, type VolumeEphemeralParams, type VolumeFromNameParams, VolumeService, checkForRenamedParams, close, initializeClient };

package/dist/index.d.ts

@@ -4991,7 +4991,7 @@ declare class FunctionCallService {
 }
 /** Optional parameters for {@link FunctionCall#get FunctionCall.get()}. */
 type FunctionCallGetParams = {
-    timeout?: number;
+    timeoutMs?: number;
 };
 /** Optional parameters for {@link FunctionCall#cancel FunctionCall.cancel()}. */
 type FunctionCallCancelParams = {
@@ -5049,7 +5049,7 @@ interface FunctionUpdateAutoscalerParams {
     minContainers?: number;
     maxContainers?: number;
     bufferContainers?: number;
-    scaledownWindow?: number;
+    scaledownWindowMs?: number;
 }
 /** Represents a deployed Modal Function, which can be invoked remotely. */
 declare class Function_ {
@@ -5216,7 +5216,9 @@ declare class ClsService {
 }
 type ClsWithOptionsParams = {
     cpu?: number;
-    memory?: number;
+    cpuLimit?: number;
+    memoryMiB?: number;
+    memoryLimitMiB?: number;
     gpu?: string;
     env?: Record<string, string>;
     secrets?: Secret[];
@@ -5224,8 +5226,8 @@ type ClsWithOptionsParams = {
     retries?: number | Retries;
     maxContainers?: number;
     bufferContainers?: number;
-    scaledownWindow?: number;
-    timeout?: number;
+    scaledownWindowMs?: number;
+    timeoutMs?: number;
 };
 type ClsWithConcurrencyParams = {
     maxInputs: number;
@@ -5457,8 +5459,8 @@ type QueueClearParams = {
 };
 /** Optional parameters for {@link Queue#get Queue.get()}. */
 type QueueGetParams = {
-    /** How long to wait if the Queue is empty (default: indefinite). */
-    timeout?: number;
+    /** How long to wait if the Queue is empty in milliseconds (default: indefinite). */
+    timeoutMs?: number;
     /** Partition to fetch values from, uses default partition if not set. */
     partition?: string;
 };
@@ -5466,12 +5468,12 @@ type QueueGetParams = {
 type QueueGetManyParams = QueueGetParams;
 /** Optional parameters for {@link Queue#put Queue.put()}. */
 type QueuePutParams = {
-    /** How long to wait if the Queue is full (default: indefinite). */
-    timeout?: number;
+    /** How long to wait if the Queue is full in milliseconds (default: indefinite). */
+    timeoutMs?: number;
     /** Partition to add items to, uses default partition if not set. */
     partition?: string;
-    /** TTL for the partition in seconds (default: 1 day). */
-    partitionTtl?: number;
+    /** TTL for the partition in milliseconds (default: 1 day). */
+    partitionTtlMs?: number;
 };
 /** Optional parameters for {@link Queue#putMany Queue.putMany()}. */
 type QueuePutManyParams = QueuePutParams;
@@ -5484,8 +5486,8 @@ type QueueLenParams = {
 };
 /** Optional parameters for {@link Queue#iterate Queue.iterate()}. */
 type QueueIterateParams = {
-    /** How long to wait between successive items before exiting iteration (default: 0). */
-    itemPollTimeout?: number;
+    /** How long to wait between successive items before exiting iteration in milliseconds (default: 0). */
+    itemPollTimeoutMs?: number;
     /** Partition to iterate, uses default partition if not set. */
     partition?: string;
 };
@@ -5520,7 +5522,7 @@ declare class Queue {
      * Remove and return the next object from the Queue.
      *
      * By default, this will wait until at least one item is present in the Queue.
-     * If `timeout` is set, raises `QueueEmptyError` if no items are available
+     * If `timeoutMs` is set, raises `QueueEmptyError` if no items are available
      * within that timeout in milliseconds.
      */
     get(params?: QueueGetParams): Promise<any | null>;
@@ -5528,7 +5530,7 @@ declare class Queue {
      * Remove and return up to `n` objects from the Queue.
      *
      * By default, this will wait until at least one item is present in the Queue.
-     * If `timeout` is set, raises `QueueEmptyError` if no items are available
+     * If `timeoutMs` is set, raises `QueueEmptyError` if no items are available
      * within that timeout in milliseconds.
      */
     getMany(n: number, params?: QueueGetManyParams): Promise<any[]>;
@@ -5536,7 +5538,7 @@ declare class Queue {
      * Add an item to the end of the Queue.
      *
      * If the Queue is full, this will retry with exponential backoff until the
-     * provided `timeout` is reached, or indefinitely if `timeout` is not set.
+     * provided `timeoutMs` is reached, or indefinitely if `timeoutMs` is not set.
      * Raises {@link QueueFullError} if the Queue is still full after the timeout.
      */
     put(v: any, params?: QueuePutParams): Promise<void>;
@@ -5544,7 +5546,7 @@ declare class Queue {
      * Add several items to the end of the Queue.
      *
      * If the Queue is full, this will retry with exponential backoff until the
-     * provided `timeout` is reached, or indefinitely if `timeout` is not set.
+     * provided `timeoutMs` is reached, or indefinitely if `timeoutMs` is not set.
      * Raises {@link QueueFullError} if the Queue is still full after the timeout.
      */
     putMany(values: any[], params?: QueuePutManyParams): Promise<void>;
@@ -5657,14 +5659,18 @@ type StreamMode = "text" | "binary";
 type SandboxCreateParams = {
     /** Reservation of physical CPU cores for the Sandbox, can be fractional. */
     cpu?: number;
+    /** Hard limit of physical CPU cores for the Sandbox, can be fractional. */
+    cpuLimit?: number;
     /** Reservation of memory in MiB. */
-    memory?: number;
+    memoryMiB?: number;
+    /** Hard limit of memory in MiB. */
+    memoryLimitMiB?: number;
     /** GPU reservation for the Sandbox (e.g. "A100", "T4:2", "A100-80GB:4"). */
     gpu?: string;
-    /** Timeout of the Sandbox container, defaults to 10 minutes. */
-    timeout?: number;
+    /** Timeout of the Sandbox container in milliseconds, defaults to 10 minutes. */
+    timeoutMs?: number;
     /** The amount of time in milliseconds that a sandbox can be idle before being terminated. */
-    idleTimeout?: number;
+    idleTimeoutMs?: number;
     /** Working directory of the Sandbox. */
     workdir?: string;
     /**
@@ -5765,7 +5771,7 @@ type SandboxExecParams = {
     /** Working directory to run the command in. */
     workdir?: string;
     /** Timeout for the process in milliseconds. Defaults to 0 (no timeout). */
-    timeout?: number;
+    timeoutMs?: number;
     /** Environment variables to set for the command. */
     env?: Record<string, string>;
     /** {@link Secret}s to inject as environment variables for the commmand.*/
@@ -5830,16 +5836,16 @@ declare class Sandbox {
      *
      * @returns A dictionary of {@link Tunnel} objects which are keyed by the container port.
      */
-    tunnels(timeout?: number): Promise<Record<number, Tunnel>>;
+    tunnels(timeoutMs?: number): Promise<Record<number, Tunnel>>;
     /**
      * Snapshot the filesystem of the Sandbox.
      *
      * Returns an {@link Image} object which can be used to spawn a new Sandbox with the same filesystem.
      *
-     * @param timeout - Timeout for the snapshot operation in milliseconds
+     * @param timeoutMs - Timeout for the snapshot operation in milliseconds
      * @returns Promise that resolves to an {@link Image}
      */
-    snapshotFilesystem(timeout?: number): Promise<Image>;
+    snapshotFilesystem(timeoutMs?: number): Promise<Image>;
     /**
      * Check if the Sandbox has finished running.
      *
@@ -5876,7 +5882,7 @@ interface ModalClientParams {
     tokenSecret?: string;
     environment?: string;
     endpoint?: string;
-    timeout?: number;
+    timeoutMs?: number;
     maxRetries?: number;
     /** @ignore */
     cpClient?: ModalGrpcClient;
@@ -5928,7 +5934,7 @@ declare class ModalClient {
 }
 type TimeoutOptions = {
     /** Timeout for this call, interpreted as a duration in milliseconds */
-    timeout?: number;
+    timeoutMs?: number;
 };
 type RetryOptions = {
     /** Number of retries to take. */
@@ -6060,4 +6066,6 @@ declare class SandboxTimeoutError extends Error {
     constructor(message?: string);
 }
 
-export { AlreadyExistsError, App, type AppFromNameParams, AppService, type ClientOptions, CloudBucketMount, Cls, type ClsFromNameParams, ClsInstance, ClsService, type ClsWithBatchingParams, type ClsWithConcurrencyParams, type ClsWithOptionsParams, ContainerProcess, type DeleteOptions, type EphemeralOptions, FunctionCall, type FunctionCallCancelParams, type FunctionCallGetParams, FunctionCallService, type FunctionFromNameParams, FunctionService, type FunctionStats, FunctionTimeoutError, type FunctionUpdateAutoscalerParams, Function_, Image, type ImageDeleteParams, type ImageDockerfileCommandsParams, ImageService, InternalFailure, InvalidError, type LookupOptions, ModalClient, type ModalClientParams, type ModalReadStream, type ModalWriteStream, NotFoundError, type Profile, Proxy, type ProxyFromNameParams, ProxyService, Queue, type QueueClearParams, type QueueDeleteParams, QueueEmptyError, type QueueEphemeralParams, type QueueFromNameParams, QueueFullError, type QueueGetParams, type QueueIterateParams, type QueueLenParams, type QueuePutParams, QueueService, RemoteError, Retries, Sandbox, type SandboxCreateParams, type SandboxExecParams, SandboxFile, type SandboxFileMode, type SandboxFromNameParams, type SandboxListParams, SandboxService, SandboxTimeoutError, Secret, type SecretFromNameParams, type SecretFromObjectParams, SecretService, type StdioBehavior, type StreamMode, Tunnel, Volume, type VolumeEphemeralParams, type VolumeFromNameParams, VolumeService, close, initializeClient };
+declare function checkForRenamedParams(params: any, renames: Record<string, string>): void;
+
+export { AlreadyExistsError, App, type AppFromNameParams, AppService, type ClientOptions, CloudBucketMount, Cls, type ClsFromNameParams, ClsInstance, ClsService, type ClsWithBatchingParams, type ClsWithConcurrencyParams, type ClsWithOptionsParams, ContainerProcess, type DeleteOptions, type EphemeralOptions, FunctionCall, type FunctionCallCancelParams, type FunctionCallGetParams, FunctionCallService, type FunctionFromNameParams, FunctionService, type FunctionStats, FunctionTimeoutError, type FunctionUpdateAutoscalerParams, Function_, Image, type ImageDeleteParams, type ImageDockerfileCommandsParams, ImageService, InternalFailure, InvalidError, type LookupOptions, ModalClient, type ModalClientParams, type ModalReadStream, type ModalWriteStream, NotFoundError, type Profile, Proxy, type ProxyFromNameParams, ProxyService, Queue, type QueueClearParams, type QueueDeleteParams, QueueEmptyError, type QueueEphemeralParams, type QueueFromNameParams, QueueFullError, type QueueGetParams, type QueueIterateParams, type QueueLenParams, type QueuePutParams, QueueService, RemoteError, Retries, Sandbox, type SandboxCreateParams, type SandboxExecParams, SandboxFile, type SandboxFileMode, type SandboxFromNameParams, type SandboxListParams, SandboxService, SandboxTimeoutError, Secret, type SecretFromNameParams, type SecretFromObjectParams, SecretService, type StdioBehavior, type StreamMode, Tunnel, Volume, type VolumeEphemeralParams, type VolumeFromNameParams, VolumeService, checkForRenamedParams, close, initializeClient };