Class SandboxService

Service for managing Sandboxes.

Normally only ever accessed via the client as:

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

Index

Constructors

Methods

create experimentalCreate fromId fromName list

Constructors

constructor

new SandboxService(client: ModalClient): SandboxService
Parameters
- client: ModalClient
Returns SandboxService
- Defined in src/sandbox.ts:650

Methods

create

create(app: App, image: Image, params?: SandboxCreateParams): Promise<Sandbox>
Create a new Sandbox in the App with the specified Image and options.
Parameters
- app: App
- image: Image
- params: SandboxCreateParams = {}
Returns Promise<Sandbox>
- Defined in src/sandbox.ts:657

experimentalCreate

experimentalCreate(
    app: App,
    image: Image,
    params?: SandboxCreateParams,
): Promise<Sandbox>
Create a new Sandbox using the experimental V2 backend.

Supported features include exec, encrypted tunnels, wait/poll/terminate, CPU and memory configuration, region placement, volumes, cloud bucket mounts (with static credentials via Secret), and filesystem snapshots.

Features like tags, memory snapshots, GPUs, custom domains, OIDC identity tokens (including oidcAuthRoleArn on a CloudBucketMount), proxies, and readiness probes are not supported.

V2 sandboxes created with this method are not currently returned by client.sandboxes.list() and cannot be looked up with client.sandboxes.fromName(). Store sandbox.sandboxId if you need to retrieve the sandbox later, and use client.sandboxes.fromId() to reattach.
Parameters
- app: App
- image: Image
- params: SandboxCreateParams = {}
Returns Promise<Sandbox>
- Defined in src/sandbox.ts:717

fromId

fromId(sandboxId: string): Promise<Sandbox>
Returns a running Sandbox object from an ID.
Parameters
- sandboxId: string
Returns Promise<Sandbox>
Sandbox with ID
- Defined in src/sandbox.ts:777

fromName

fromName(
    appName: string,
    name: string,
    params?: SandboxFromNameParams,
): Promise<Sandbox>
Get a running Sandbox by name from a deployed App.

Raises a NotFoundError if no running Sandbox is found with the given name. A Sandbox's name is the name argument passed to sandboxes.create().
Parameters
- appName: string
  Name of the deployed App
- name: string
  Name of the Sandbox
- Optionalparams: SandboxFromNameParams
  Optional parameters for getting the Sandbox
Returns Promise<Sandbox>
Promise that resolves to a Sandbox
- Defined in src/sandbox.ts:793

list

list(params?: SandboxListParams): AsyncGenerator<Sandbox, void, unknown>
List all Sandboxes for the current Environment or App ID (if specified). If tags are specified, only Sandboxes that have at least those tags are returned.
Parameters
- params: SandboxListParams = {}
Returns AsyncGenerator<Sandbox, void, unknown>
- Defined in src/sandbox.ts:818