Class Sandbox

ReadonlysandboxId

stderr

stdin

stdout

exec

• exec(
      command: string[],
      options?: ExecOptions & { mode?: "text" },
  ): Promise<ContainerProcess<string>>

  Parameters

  • command: string[]
  • Optionaloptions: ExecOptions & { mode?: "text" }

  Returns Promise<ContainerProcess<string>>

• exec(
      command: string[],
      options: ExecOptions & { mode: "binary" },
  ): Promise<ContainerProcess<Uint8Array<ArrayBufferLike>>>

  Parameters

  • command: string[]
  • options: ExecOptions & { mode: "binary" }

  Returns Promise<ContainerProcess<Uint8Array<ArrayBufferLike>>>

open

• open(path: string, mode?: SandboxFileMode): Promise<SandboxFile>

  Open a file in the Sandbox filesystem.

  Parameters

  • path: string

    Path to the file to open
  • mode: SandboxFileMode = "r"

    File open mode (r, w, a, r+, w+, a+)

  Returns Promise<SandboxFile>

  Promise that resolves to a SandboxFile

poll

• poll(): Promise<null | number>

  Check if the Sandbox has finished running.

  Returns null if the Sandbox is still running, else returns the exit code.

  Returns Promise<null | number>

setTags

• setTags(tags: Record<string, string>): Promise<void>

  Set tags (key-value pairs) on the Sandbox. Tags can be used to filter results in Sandbox.list.

  Parameters

  • tags: Record<string, string>

  Returns Promise<void>

snapshotFilesystem

• snapshotFilesystem(timeout?: number): Promise<Image>

  Snapshot the filesystem of the Sandbox.

  Returns an Image object which can be used to spawn a new Sandbox with the same filesystem.

  Parameters

  • timeout: number = 55000

    Timeout for the snapshot operation in milliseconds

  Returns Promise<Image>

  Promise that resolves to an Image

terminate

• terminate(): Promise<void>

  Returns Promise<void>

tunnels

• tunnels(timeout?: number): Promise<Record<number, Tunnel>>

  Get Tunnel metadata for the Sandbox.

  Raises SandboxTimeoutError if the tunnels are not available after the timeout.

  Parameters

  • timeout: number = 50000

  Returns Promise<Record<number, Tunnel>>

  A dictionary of Tunnel objects which are keyed by the container port.

wait

• wait(): Promise<number>

  Returns Promise<number>

StaticfromId

• fromId(sandboxId: string): Promise<Sandbox>

  Returns a running Sandbox object from an ID.

  Parameters

  • sandboxId: string

  Returns Promise<Sandbox>

  Sandbox with ID

StaticfromName

• fromName(appName: string, name: string, environment?: string): 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 App.createSandbox.

  Parameters

  • appName: string

    Name of the deployed App
  • name: string

    Name of the Sandbox
  • Optionalenvironment: string

    Optional override for the environment

  Returns Promise<Sandbox>

  Promise that resolves to a Sandbox

Staticlist

• list(options?: SandboxListOptions): 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

  • options: SandboxListOptions = {}

  Returns AsyncGenerator<Sandbox, void, unknown>