Skip to content

@codesoul-co/hypha-core / modules/runtime/runtime-activity-helper

模块用法

用于执行该边界的运行时行为。Runtime activity helper 模块公开 2 类、1 接口。

从包入口导入

ts
import {
  DefaultRuntimeActivityHelper,
  RuntimeEventActivityLifecycleCommitPort,
} from '@codesoul-co/hypha-core';

import type {
  DefaultRuntimeActivityHelperOptions,
} from '@codesoul-co/hypha-core';

使用要点

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

公共导出

Symbol种类签名说明
DefaultRuntimeActivityHelpernew DefaultRuntimeActivityHelper(options: DefaultRuntimeActivityHelperOptions): DefaultRuntimeActivityHelperDefault Runtime Activity Helper 类,共公开 6 个构造函数或成员;精确签名见本条目的声明与成员表。
RuntimeEventActivityLifecycleCommitPortnew RuntimeEventActivityLifecycleCommitPort(events: RuntimeEventCommitPort): RuntimeEventActivityLifecycleCommitPortRuntime Event Activity Lifecycle Commit Port 类,共公开 2 个构造函数或成员;精确签名见本条目的声明与成员表。
DefaultRuntimeActivityHelperOptions接口interface DefaultRuntimeActivityHelperOptionsDefault Runtime Activity Helper Options 接口,共包含 6 个公开字段或方法。

DefaultRuntimeActivityHelper

Default Runtime Activity Helper 类,共公开 6 个构造函数或成员;精确签名见本条目的声明与成员表。

声明

text
export declare class DefaultRuntimeActivityHelper implements RuntimeActivityHelper {
    constructor(options: DefaultRuntimeActivityHelperOptions);
    tool(request: RuntimeActivityRequest): Promise<RuntimeActivityObservation>;
    memory(request: RuntimeActivityRequest): Promise<RuntimeActivityObservation>;
    model(request: RuntimeActivityRequest): Promise<RuntimeActivityObservation>;
    execution(request: RuntimeActivityRequest): Promise<RuntimeActivityObservation>;
    custom(request: RuntimeActivityRequest): Promise<RuntimeActivityObservation>;
}

公开成员

成员种类签名说明
constructor构造函数(options: DefaultRuntimeActivityHelperOptions): DefaultRuntimeActivityHelper创建该类的实例。
custom方法custom(request: RuntimeActivityRequest): Promise<RuntimeActivityObservation>公开方法;参数与返回类型以签名列为准。
execution方法execution(request: RuntimeActivityRequest): Promise<RuntimeActivityObservation>公开方法;参数与返回类型以签名列为准。
memory方法memory(request: RuntimeActivityRequest): Promise<RuntimeActivityObservation>公开方法;参数与返回类型以签名列为准。
model方法model(request: RuntimeActivityRequest): Promise<RuntimeActivityObservation>公开方法;参数与返回类型以签名列为准。
tool方法tool(request: RuntimeActivityRequest): Promise<RuntimeActivityObservation>公开方法;参数与返回类型以签名列为准。

RuntimeEventActivityLifecycleCommitPort

Runtime Event Activity Lifecycle Commit Port 类,共公开 2 个构造函数或成员;精确签名见本条目的声明与成员表。

声明

text
export declare class RuntimeEventActivityLifecycleCommitPort implements RuntimeActivityLifecycleCommitPort {
    constructor(events: RuntimeEventCommitPort);
    append(request: RuntimeActivityLifecycleCommitRequest): Promise<FrameworkEvent>;
}

公开成员

成员种类签名说明
append方法append(request: RuntimeActivityLifecycleCommitRequest): Promise<FrameworkEvent>公开方法;参数与返回类型以签名列为准。
constructor构造函数(events: RuntimeEventCommitPort): RuntimeEventActivityLifecycleCommitPort创建该类的实例。

DefaultRuntimeActivityHelperOptions

Default Runtime Activity Helper Options 接口,共包含 6 个公开字段或方法。

声明

text
export interface DefaultRuntimeActivityHelperOptions {
    execution: RuntimeHelperExecutionScope;
    ids: RuntimeIdHelper;
    clock: {
        now(): Promise<string>;
    };
    dispatch: RuntimeActivityDispatchPort;
    lifecycle: RuntimeActivityLifecycleCommitPort;
    abortSignal: AbortSignal;
}

契约成员

成员种类签名说明
abortSignal属性abortSignal: AbortSignal公开属性;类型、只读和可选状态以签名列为准。
clock属性clock: { now(): Promise<string>; }公开属性;类型、只读和可选状态以签名列为准。
dispatch属性dispatch: RuntimeActivityDispatchPort公开属性;类型、只读和可选状态以签名列为准。
execution属性execution: RuntimeHelperExecutionScope公开属性;类型、只读和可选状态以签名列为准。
ids属性ids: RuntimeIdHelper公开属性;类型、只读和可选状态以签名列为准。
lifecycle属性lifecycle: RuntimeActivityLifecycleCommitPort公开属性;类型、只读和可选状态以签名列为准。