WarmPoolService

Service for managing Daytona Warm Pools.

This service provides methods to list, create, update, and delete Warm Pools.

Constructors

Constructor

new WarmPoolService(warmPoolsApi: WarmPoolsApi): WarmPoolService;

Parameters:

• warmPoolsApi WarmPoolsApi

Returns:

• WarmPoolService

Methods

create()

create(params: CreateWarmPool): Promise<WarmPool>;

Creates a new Warm Pool.

Parameters:

• params CreateWarmPool - Parameters for the new Warm Pool

Returns:

• Promise<WarmPool> - The newly created Warm Pool

Throws:

If a Warm Pool for the same snapshot and region already exists

Example:

const daytona = new Daytona();
const pool = await daytona.warmPool.create({ snapshot: 'my-snapshot', pool: 5 });
console.log(`Created warm pool ${pool.id} in ${pool.target}`);

delete()

delete(warmPoolId: string): Promise<void>;

Deletes a Warm Pool.

Parameters:

• warmPoolId string - ID of the Warm Pool to delete

Returns:

• Promise<void>

Throws:

If the Warm Pool does not exist

Example:

const daytona = new Daytona();
await daytona.warmPool.delete("warm-pool-id");

list()

list(): Promise<WarmPool[]>;

Lists all Warm Pools in the organization.

Returns:

• Promise<WarmPool[]> - List of all Warm Pools

Example:

const daytona = new Daytona();
const pools = await daytona.warmPool.list();
pools.forEach(pool => console.log(`${pool.snapshot}: ${pool.currentSize}/${pool.pool} ready`));

update()

update(warmPoolId: string, params: UpdateWarmPool): Promise<WarmPool>;

Updates the desired size of a Warm Pool.

Parameters:

• warmPoolId string - ID of the Warm Pool to update
• params UpdateWarmPool - Fields to update (pool: 0 drains the pool)

Returns:

• Promise<WarmPool> - The updated Warm Pool

Throws:

If the Warm Pool does not exist

Example:

const daytona = new Daytona();
const pool = await daytona.warmPool.update("warm-pool-id", { pool: 10 });

---

WarmPool

type WarmPool = WarmPoolDto & {
  __brand: "WarmPool";
};

Represents a Daytona Warm Pool which keeps ready-to-use Sandboxes for a snapshot.

currentSize versus pool is the pool’s status: currentSize is the number of ready warm sandboxes, pool is the desired number. errorReason is set when the pool cannot be filled.

Type Declaration

__brand

__brand: "WarmPool";