Skip to content

@codesoul-co/hypha-adapters-local / local-process-output-stream-registry

模块用法

用于注册并解析版本化能力或实现。Local process output stream registry 模块公开 1 类、1 接口。

从包入口导入

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

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

使用要点

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

公共导出

Symbol种类签名说明
LocalProcessOutputStreamRegistrynew LocalProcessOutputStreamRegistry(options?: LocalProcessOutputStreamRegistryOptions): LocalProcessOutputStreamRegistryBounded replay and live-follow registry for Local Process output. Raw bytes are represented as base64 so chunk boundaries cannot corrupt UTF-8.
LocalProcessOutputStreamRegistryOptions接口interface LocalProcessOutputStreamRegistryOptionsLocal Process Output Stream Registry Options 接口,共包含 3 个公开字段或方法。

LocalProcessOutputStreamRegistry

Bounded replay and live-follow registry for Local Process output. Raw bytes are represented as base64 so chunk boundaries cannot corrupt UTF-8.

声明

text
export declare class LocalProcessOutputStreamRegistry {
    constructor(options?: LocalProcessOutputStreamRegistryOptions);
    begin(executionId: string, principal: ExecutionPrincipal): void;
    publish(executionId: string, stream: CommandOutputChunk['stream'], bytes: Uint8Array, truncated?: boolean): CommandOutputChunk;
    complete(executionId: string): void;
    stream(request: RemoteOutputStreamRequest): AsyncIterable<CommandOutputChunk>;
    close(): void;
}

公开成员

成员种类签名说明
begin方法begin(executionId: string, principal: ExecutionPrincipal): void公开方法;参数与返回类型以签名列为准。
close方法close(): void公开方法;参数与返回类型以签名列为准。
complete方法complete(executionId: string): void公开方法;参数与返回类型以签名列为准。
constructor构造函数(options?: LocalProcessOutputStreamRegistryOptions): LocalProcessOutputStreamRegistry创建该类的实例。
publish方法publish(executionId: string, stream: CommandOutputChunk["stream"], bytes: Uint8Array, truncated?: boolean): CommandOutputChunk公开方法;参数与返回类型以签名列为准。
stream方法stream(request: RemoteOutputStreamRequest): AsyncIterable<CommandOutputChunk>公开方法;参数与返回类型以签名列为准。

LocalProcessOutputStreamRegistryOptions

Local Process Output Stream Registry Options 接口,共包含 3 个公开字段或方法。

声明

text
export interface LocalProcessOutputStreamRegistryOptions {
    maxRetainedChunks?: number;
    maxTrackedExecutions?: number;
    now?: () => string;
}

契约成员

成员种类签名说明
maxRetainedChunks属性maxRetainedChunks?: number公开属性;类型、只读和可选状态以签名列为准。
maxTrackedExecutions属性maxTrackedExecutions?: number公开属性;类型、只读和可选状态以签名列为准。
now方法now?(): string公开方法;参数与返回类型以签名列为准。