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 fromId fromName list

Constructors

constructor

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

Methods

create

create(app: App, image: Image, params?: SandboxCreateParams): Promise<Sandbox>
Parameters
- app: App
  Appインスタンス
- image: Image
  コンテナイメージ
- params: SandboxCreateParams = {}
  Sandbox作成パラメータ
Returns Promise<Sandbox>
作成されたSandbox

Description
指定したAppとImageで新しいSandboxを作成する
- Defined in src/sandbox.ts:536

fromId

fromId(sandboxId: string): Promise<Sandbox>
Parameters
- sandboxId: string
  Sandbox ID
Returns Promise<Sandbox>
Sandboxインスタンス

Description
IDから実行中のSandboxを取得する

Throws
NotFoundError 指定されたSandboxが存在しない場合
- Defined in src/sandbox.ts:582

fromName

fromName(
    appName: string,
    name: string,
    params?: SandboxFromNameParams,
): Promise<Sandbox>
Parameters
- appName: string
  アプリ名
- name: string
  Sandbox名
- Optionalparams: SandboxFromNameParams
  オプションパラメータ
Returns Promise<Sandbox>
Sandboxインスタンス

Description
デプロイ済みApp内の名前付きSandboxを取得する

Throws
NotFoundError 指定されたSandboxが存在しない場合
- Defined in src/sandbox.ts:605

list

list(params?: SandboxListParams): AsyncGenerator<Sandbox, void, unknown>
Parameters
- params: SandboxListParams = {}
  フィルタリングパラメータ
Returns AsyncGenerator<Sandbox, void, unknown>
Description
現在の環境またはApp IDのSandbox一覧を返す
- Defined in src/sandbox.ts:630