TypeScript SDK overview

​

Key features

• Serverless sandboxes: Create isolated execution environments with custom images, volumes, and secrets
• Function calling: Invoke Modal Functions deployed with the Python SDK
• Resource management: Work with Apps, Volumes, Queues, Secrets, and other Modal resources
• Custom images: Build images from registries (Docker Hub, AWS ECR, GCP Artifact Registry) or with Dockerfile commands
• Telemetry and observability: Add custom gRPC middleware for tracing and monitoring
• Full TypeScript support: Type-safe APIs with comprehensive TypeScript definitions

​

What you can do

​

Run code in sandboxes

import { ModalClient } from "modal";

const modal = new ModalClient();

const app = await modal.apps.fromName("my-app", {
  createIfMissing: true,
});
const image = modal.images.fromRegistry("alpine:3.21");

const sb = await modal.sandboxes.create(app, image, {
  command: ["echo", "Hello from Modal!"],
});

console.log(await sb.stdout.readText());
await sb.terminate();

​

Call deployed functions

const echo = await modal.functions.fromName(
  "my-app",
  "echo_string",
);

const result = await echo.remote(["Hello world!"]);
console.log(result);

​

Work with classes

const cls = await modal.cls.fromName("my-app", "MyClass");
const instance = await cls.instance();
const method = instance.method("process_data");

const result = await method.remote([{ data: "value" }]);

​

Build custom images

const image = modal.images
  .fromRegistry("python:3.13")
  .dockerfileCommands([
    "RUN pip install numpy pandas",
    "RUN apt-get update && apt-get install -y curl",
  ]);

const sb = await modal.sandboxes.create(app, image);

​

Runtime support

• Node.js: Version 22 or later
• Module formats: ES Modules and CommonJS (both import and require())
• Runtimes: Node.js, Deno, and Bun

​

Feature parity with Python SDK

• Available: Sandboxes, Functions, Classes, Images, Volumes, Queues, Secrets, Proxies
• Not yet available: Defining Modal Functions, Volume filesystem API, some Image building APIs, Dicts

​

Next steps