HYPHA / DOCS

简体中文

English

简体中文

English

@codesoul-co/hypha-adapters-local / docker-sandbox-provider-factory ​

模块用法 ​

用于把外部或本地 Provider 绑定到 Hypha Port。Docker sandbox provider factory 模块公开 1 类、1 常量、1 接口。

从包入口导入 ​

ts
import {
  DockerSandboxProviderFactory,
  DOCKER_SANDBOX_PROVIDER_ID,
} from '@codesoul-co/hypha-adapters-local';

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

使用要点 ​

  • 1 个类型/接口用于应用代码、Adapter 或测试中的静态契约；请使用 import type，运行时不应依赖它们。
  • 1 个类提供可实例化的运行时实现；构造参数与公开方法在各自条目中完整列出。
  • 1 个常量/枚举提供稳定值、Schema、Definition 或默认配置；应复用这些导出，避免在应用中复制内部值。

公共导出 ​

Symbol种类签名说明
DockerSandboxProviderFactory类new DockerSandboxProviderFactory(options: DockerSandboxProviderFactoryOptions): DockerSandboxProviderFactoryComposition adapter for the accepted Docker Provider. Registration remains explicit: callers add this factory to the Core SandboxProviderRegistry.
DOCKER_SANDBOX_PROVIDER_ID常量const DOCKER_SANDBOX_PROVIDER_ID: "provider.docker"由 docker-sandbox-provider-factory 模块导出的 DOCKER SANDBOX PROVIDER ID 常量。
DockerSandboxProviderFactoryOptions接口interface DockerSandboxProviderFactoryOptionsDocker Sandbox Provider Factory Options 接口，共包含 6 个公开字段或方法。

DockerSandboxProviderFactory ​

Composition adapter for the accepted Docker Provider. Registration remains explicit: callers add this factory to the Core SandboxProviderRegistry.

声明 ​

text
export declare class DockerSandboxProviderFactory implements SandboxProviderFactory {
    readonly providerType: "docker";
    readonly providerId: string;
    constructor(options: DockerSandboxProviderFactoryOptions);
    create(): SandboxProvider;
}

公开成员 ​

成员种类签名说明
constructor构造函数(options: DockerSandboxProviderFactoryOptions): DockerSandboxProviderFactory创建该类的实例。
create方法create(): SandboxProvider公开方法；参数与返回类型以签名列为准。
providerId属性readonly providerId: string公开属性；类型、只读和可选状态以签名列为准。
providerType属性readonly providerType: "docker"公开属性；类型、只读和可选状态以签名列为准。

DOCKER_SANDBOX_PROVIDER_ID ​

由 docker-sandbox-provider-factory 模块导出的 DOCKER SANDBOX PROVIDER ID 常量。

声明 ​

text
export declare const DOCKER_SANDBOX_PROVIDER_ID: "provider.docker";

DockerSandboxProviderFactoryOptions ​

Docker Sandbox Provider Factory Options 接口，共包含 6 个公开字段或方法。

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

声明 ​

text
export interface DockerSandboxProviderFactoryOptions {
    engineScopeId: string;
    policy: DockerExecutionPolicyResolverOptions;
    outputArtifacts: DockerExecutionArtifactStreamPort;
    providerId?: string;
    dockerPath?: string;
    transport?: DockerCommandTransport;
}

契约成员 ​

成员种类签名说明
dockerPath属性dockerPath?: string公开属性；类型、只读和可选状态以签名列为准。
engineScopeId属性engineScopeId: string公开属性；类型、只读和可选状态以签名列为准。
outputArtifacts属性outputArtifacts: DockerExecutionArtifactStreamPort公开属性；类型、只读和可选状态以签名列为准。
policy属性policy: DockerExecutionPolicyResolverOptions公开属性；类型、只读和可选状态以签名列为准。
providerId属性providerId?: string公开属性；类型、只读和可选状态以签名列为准。
transport属性transport?: DockerCommandTransport公开属性；类型、只读和可选状态以签名列为准。