@codesoul-co/hypha-adapters-local / local-sandbox-lifecycle

• 包索引: @codesoul-co/hypha-adapters-local
• 源码: packages/adapters-local/src/local-sandbox-lifecycle.ts
• 导出数: 2

模块用法

用于使用该功能边界的公共契约与操作。Local sandbox lifecycle 模块公开 1 类、1 接口。

从包入口导入

import {
  LocalSandboxLifecycle,
} from '@codesoul-co/hypha-adapters-local';

import type {
  LocalSandboxLifecycleOptions,
} from '@codesoul-co/hypha-adapters-local';

使用要点

• 1 个类型/接口用于应用代码、Adapter 或测试中的静态契约；请使用 import type，运行时不应依赖它们。
• 1 个类提供可实例化的运行时实现；构造参数与公开方法在各自条目中完整列出。

公共导出

Symbol	种类	签名	说明
LocalSandboxLifecycle	类	new LocalSandboxLifecycle(options: LocalSandboxLifecycleOptions): LocalSandboxLifecycle	Local Process identity wrapper around the provider-neutral lifecycle state.
LocalSandboxLifecycleOptions	接口	interface LocalSandboxLifecycleOptions	Local Sandbox Lifecycle Options 接口，共包含 4 个公开字段或方法。

LocalSandboxLifecycle

Local Process identity wrapper around the provider-neutral lifecycle state.

• 种类: 类
• 导入: import { LocalSandboxLifecycle } from '@codesoul-co/hypha-adapters-local';
• 源码模块: local-sandbox-lifecycle

声明

export declare class LocalSandboxLifecycle extends InMemorySandboxLifecycle {
    constructor(options: LocalSandboxLifecycleOptions);
}

公开成员

成员	种类	签名	说明
beginTermination	方法	beginTermination(input: SandboxTerminateRequest): SandboxRecord	公开方法；参数与返回类型以签名列为准。
cleanup	方法	cleanup(input: SandboxCleanupRequest): void	公开方法；参数与返回类型以签名列为准。
constructor	构造函数	(options: LocalSandboxLifecycleOptions): LocalSandboxLifecycle	创建该类的实例。
create	方法	create(input: SandboxCreateRequest, metadata: Record<string, unknown>): SandboxRecord	公开方法；参数与返回类型以签名列为准。
environmentForCommand	方法	environmentForCommand(request: CommandExecutionRequest): ExecutionEnvironmentSpec	公开方法；参数与返回类型以签名列为准。
finishTermination	方法	finishTermination(sandboxId: string): SandboxRecord	公开方法；参数与返回类型以签名列为准。
markBusy	方法	markBusy(sandboxId: string, executionId: string): SandboxRecord	公开方法；参数与返回类型以签名列为准。
markExecutionComplete	方法	markExecutionComplete(sandboxId: string, executionId: string, completedAt: string): SandboxRecord	公开方法；参数与返回类型以签名列为准。
start	方法	start(input: SandboxStartRequest): SandboxRecord	公开方法；参数与返回类型以签名列为准。
status	方法	status(input: SandboxStatusRequest): SandboxRecord | null	公开方法；参数与返回类型以签名列为准。

LocalSandboxLifecycleOptions

Local Sandbox Lifecycle Options 接口，共包含 4 个公开字段或方法。

• 种类: 接口
• 导入: import type { LocalSandboxLifecycleOptions } from '@codesoul-co/hypha-adapters-local';
• 源码模块: local-sandbox-lifecycle

声明

export interface LocalSandboxLifecycleOptions {
    providerId: string;
    workspaceRoot: string;
    now?: () => string;
    sandboxId?: (request: SandboxCreateRequest) => string;
}

契约成员

成员	种类	签名	说明
now	方法	now?(): string	公开方法；参数与返回类型以签名列为准。
providerId	属性	providerId: string	公开属性；类型、只读和可选状态以签名列为准。
sandboxId	方法	sandboxId?(request: SandboxCreateRequest): string	公开方法；参数与返回类型以签名列为准。
workspaceRoot	属性	workspaceRoot: string	公开属性；类型、只读和可选状态以签名列为准。