Skip to content

@codesoul-co/hypha-adapters-local / remote-sandbox-provider-factory

模块用法

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

从包入口导入

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

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

使用要点

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

公共导出

Symbol种类签名说明
RemoteSandboxProviderFactorynew RemoteSandboxProviderFactory(options: RemoteSandboxProviderFactoryOptions): RemoteSandboxProviderFactoryExplicit composition boundary for a remote Sandbox deployment. Credentials remain late-bound through the transport credentialProvider so rotation does not require rebuilding the registry or retaining a token in the Factory.
REMOTE_SANDBOX_PROVIDER_ID常量const REMOTE_SANDBOX_PROVIDER_ID: "provider.remote-sandbox"remote-sandbox-provider-factory 模块导出的 REMOTE SANDBOX PROVIDER ID 常量。
RemoteSandboxProviderFactoryOptions接口interface RemoteSandboxProviderFactoryOptions extends Omit<RemoteSandboxHttpTransportOptions, 'baseUrl'>Remote Sandbox Provider Factory Options 接口,共包含 10 个公开字段或方法。

RemoteSandboxProviderFactory

Explicit composition boundary for a remote Sandbox deployment. Credentials remain late-bound through the transport credentialProvider so rotation does not require rebuilding the registry or retaining a token in the Factory.

声明

text
export declare class RemoteSandboxProviderFactory implements SandboxProviderFactory {
    readonly providerType: "remote_sandbox";
    readonly providerId: string;
    constructor(options: RemoteSandboxProviderFactoryOptions);
    create(): SandboxProvider;
}

公开成员

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

REMOTE_SANDBOX_PROVIDER_ID

remote-sandbox-provider-factory 模块导出的 REMOTE SANDBOX PROVIDER ID 常量。

声明

text
export declare const REMOTE_SANDBOX_PROVIDER_ID: "provider.remote-sandbox";

RemoteSandboxProviderFactoryOptions

Remote Sandbox Provider Factory Options 接口,共包含 10 个公开字段或方法。

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

声明

text
export interface RemoteSandboxProviderFactoryOptions extends Omit<RemoteSandboxHttpTransportOptions, 'baseUrl'> {
    baseUrl: string;
    providerId?: string;
    transport?: RemoteSandboxTransport;
}

契约成员

成员种类签名说明
baseUrl属性baseUrl: string公开属性;类型、只读和可选状态以签名列为准。
credentialProvider方法credentialProvider(): Promise<RemoteSandboxHttpCredential>公开方法;参数与返回类型以签名列为准。
fetch方法fetch?(url: string, request: RemoteSandboxHttpRequest): Promise<RemoteSandboxHttpResponse>公开方法;参数与返回类型以签名列为准。
maxCredentialTtlMs属性maxCredentialTtlMs?: number公开属性;类型、只读和可选状态以签名列为准。
maxNdjsonLineCharacters属性maxNdjsonLineCharacters?: number公开属性;类型、只读和可选状态以签名列为准。
minCredentialRemainingMs属性minCredentialRemainingMs?: number公开属性;类型、只读和可选状态以签名列为准。
now方法now?(): number公开方法;参数与返回类型以签名列为准。
providerId属性providerId?: string公开属性;类型、只读和可选状态以签名列为准。
requestTimeoutMs属性requestTimeoutMs?: number公开属性;类型、只读和可选状态以签名列为准。
transport属性transport?: RemoteSandboxTransport公开属性;类型、只读和可选状态以签名列为准。