modal-ts
    Preparing search index...

    Class ModalClient

    The main client for interacting with Modal's cloud infrastructure.

    ModalClient provides access to all Modal services through service properties. Create a client instance and use its service properties to manage Apps, Functions, * Sandboxes, and other Modal resources.

    import { ModalClient } from "modal";

    const modal = new ModalClient();

    const app = await modal.apps.fromName("my-app");
    const image = modal.images.fromRegistry("python:3.13");
    const sb = await modal.sandboxes.create(app, image);
    Index

    Constructors

    constructor

    Properties

    apps cloudBucketMounts cls cpClient functionCalls functions images logger profile proxies queues sandboxes secrets volumes

    Methods

    close environmentName imageBuilderVersion ipClient version

    Constructors

    Properties

    apps: AppService
    cloudBucketMounts: CloudBucketMountService
    cls: ClsService
    cpClient: ModalGrpcClient
    functionCalls: FunctionCallService
    functions: FunctionService
    images: ImageService
    logger: Logger
    profile: Profile
    proxies: ProxyService
    queues: QueueService
    sandboxes: SandboxService
    secrets: SecretService
    volumes: VolumeService

    Methods

    • Returns void

      クライアントを閉じて認証トークンのリフレッシュを停止する

    • Parameters

      • Optionalenvironment: string

        明示的な環境名(省略時はプロファイルの値)

      Returns string

      環境名

      有効な環境名を返す

    • Parameters

      • Optionalversion: string

        明示的なバージョン(省略時はプロファイルの値)

      Returns string

      バージョン文字列

      イメージビルダーのバージョンを返す

      "2024.10"
    • Internal

      Parameters

      • serverUrl: string

      Returns ModalGrpcClient

    • Returns string

      バージョン文字列

      SDKバージョン文字列を返す

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods