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

• Package index: @codesoul-co/hypha-adapters-local
• Source: packages/adapters-local/src/local-sandbox-lifecycle.ts
• Exports: 2

Using this module

Use the Local sandbox lifecycle module for using the public contracts and operations for this capability boundary. It exports 1 class, 1 interface.

Import from the package entrypoint

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

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

Usage patterns

• Use the 1 type/interface export as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.
• The module exposes 1 class as constructable runtime implementations. Each symbol entry lists its constructor and public methods.

Public exports

Symbol	Kind	Signature	Description
LocalSandboxLifecycle	class	new LocalSandboxLifecycle(options: LocalSandboxLifecycleOptions): LocalSandboxLifecycle	Local Process identity wrapper around the provider-neutral lifecycle state.
LocalSandboxLifecycleOptions	interface	interface LocalSandboxLifecycleOptions	Local Sandbox Lifecycle Options interface with 4 public fields or methods.

LocalSandboxLifecycle

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

• Kind: class
• Import: import { LocalSandboxLifecycle } from '@codesoul-co/hypha-adapters-local';
• Source module: local-sandbox-lifecycle

Declaration

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

Public members

Member	Kind	Signature	Description
beginTermination	method	beginTermination(input: SandboxTerminateRequest): SandboxRecord	Public method; parameters and return type are shown in the signature.
cleanup	method	cleanup(input: SandboxCleanupRequest): void	Public method; parameters and return type are shown in the signature.
constructor	constructor	(options: LocalSandboxLifecycleOptions): LocalSandboxLifecycle	Creates an instance of this class.
create	method	create(input: SandboxCreateRequest, metadata: Record<string, unknown>): SandboxRecord	Public method; parameters and return type are shown in the signature.
environmentForCommand	method	environmentForCommand(request: CommandExecutionRequest): ExecutionEnvironmentSpec	Public method; parameters and return type are shown in the signature.
finishTermination	method	finishTermination(sandboxId: string): SandboxRecord	Public method; parameters and return type are shown in the signature.
markBusy	method	markBusy(sandboxId: string, executionId: string): SandboxRecord	Public method; parameters and return type are shown in the signature.
markExecutionComplete	method	markExecutionComplete(sandboxId: string, executionId: string, completedAt: string): SandboxRecord	Public method; parameters and return type are shown in the signature.
start	method	start(input: SandboxStartRequest): SandboxRecord	Public method; parameters and return type are shown in the signature.
status	method	status(input: SandboxStatusRequest): SandboxRecord | null	Public method; parameters and return type are shown in the signature.

LocalSandboxLifecycleOptions

Local Sandbox Lifecycle Options interface with 4 public fields or methods.

• Kind: interface
• Import: import type { LocalSandboxLifecycleOptions } from '@codesoul-co/hypha-adapters-local';
• Source module: local-sandbox-lifecycle

Declaration

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

Contract members

Member	Kind	Signature	Description
now	method	now?(): string	Public method; parameters and return type are shown in the signature.
providerId	property	providerId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
sandboxId	method	sandboxId?(request: SandboxCreateRequest): string	Public method; parameters and return type are shown in the signature.
workspaceRoot	property	workspaceRoot: string	Public property; its type, readonly modifier and optionality are shown in the signature.