modal 0.3.4 → 0.3.5

package/dist/index.d.ts

@@ -95,6 +95,14 @@ declare class App {
     imageFromRegistry(tag: string): Promise<Image>;
 }
 
+declare enum FunctionCallInvocationType {
+    FUNCTION_CALL_INVOCATION_TYPE_UNSPECIFIED = 0,
+    FUNCTION_CALL_INVOCATION_TYPE_SYNC_LEGACY = 1,
+    FUNCTION_CALL_INVOCATION_TYPE_ASYNC_LEGACY = 2,
+    FUNCTION_CALL_INVOCATION_TYPE_ASYNC = 3,
+    FUNCTION_CALL_INVOCATION_TYPE_SYNC = 4,
+    UNRECOGNIZED = -1
+}
 declare enum ParameterType {
     PARAM_TYPE_UNSPECIFIED = 0,
     PARAM_TYPE_STRING = 1,
@@ -145,6 +153,28 @@ interface MessageFns<T> {
     fromPartial(object: DeepPartial<T>): T;
 }
 
+type FunctionCallGetOptions = {
+    timeout?: number;
+};
+type FunctionCallCancelOptions = {
+    terminateContainers?: boolean;
+};
+/**
+ * Represents a Modal FunctionCall. Function Calls are Function invocations with
+ * a given input. They can be consumed asynchronously (see `get()`) or cancelled
+ * (see `cancel()`).
+ */
+declare class FunctionCall {
+    readonly functionCallId: string;
+    constructor(functionCallId: string);
+    /** Create a new function call from ID. */
+    fromId(functionCallId: string): FunctionCall;
+    /** Get the result of a function call, optionally waiting with a timeout. */
+    get(options?: FunctionCallGetOptions): Promise<any>;
+    /** Cancel a running function call. */
+    cancel(options?: FunctionCallCancelOptions): Promise<void>;
+}
+
 /** Represents a deployed Modal Function, which can be invoked remotely. */
 declare class Function_ {
     readonly functionId: string;
@@ -152,6 +182,8 @@ declare class Function_ {
     constructor(functionId: string, methodName?: string);
     static lookup(appName: string, name: string, options?: LookupOptions): Promise<Function_>;
     remote(args?: any[], kwargs?: Record<string, any>): Promise<any>;
+    spawn(args?: any[], kwargs?: Record<string, any>): Promise<FunctionCall>;
+    execFunctionCall(args?: any[], kwargs?: Record<string, any>, invocationType?: FunctionCallInvocationType): Promise<string>;
 }
 
 /** Represents a deployed Modal Cls. */
@@ -170,7 +202,7 @@ declare class ClsInstance {
 }
 
 /** Function execution exceeds the allowed time limit. */
-declare class TimeoutError extends Error {
+declare class FunctionTimeoutError extends Error {
     constructor(message: string);
 }
 /** An error on the Modal server, or a Python exception. */
@@ -186,4 +218,4 @@ declare class NotFoundError extends Error {
     constructor(message: string);
 }
 
-export { App, Cls, ClsInstance, Function_, Image, InternalFailure, type LookupOptions, NotFoundError, RemoteError, Sandbox, type SandboxCreateOptions, type StdioBehavior, type StreamMode, TimeoutError };
+export { App, Cls, ClsInstance, FunctionCall, type FunctionCallCancelOptions, type FunctionCallGetOptions, FunctionTimeoutError, Function_, Image, InternalFailure, type LookupOptions, NotFoundError, RemoteError, Sandbox, type SandboxCreateOptions, type StdioBehavior, type StreamMode };