Skip to content

@codesoul-co/hypha-core / modules/runtime/runtime-activity-descriptor-store

模块用法

用于持久化并读取该边界的数据。Runtime activity descriptor store 模块公开 1 类、3 接口。

从包入口导入

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

import type {
  ArtifactRuntimeActivityDescriptorStoreOptions,
  RuntimeActivityDescriptorReference,
  RuntimeActivityDescriptorStore,
} from '@codesoul-co/hypha-core';

使用要点

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

公共导出

Symbol种类签名说明
ArtifactRuntimeActivityDescriptorStorenew ArtifactRuntimeActivityDescriptorStore(options: ArtifactRuntimeActivityDescriptorStoreOptions): ArtifactRuntimeActivityDescriptorStorePersists immutable Activity descriptors outside HumanTask Events.
ArtifactRuntimeActivityDescriptorStoreOptions接口interface ArtifactRuntimeActivityDescriptorStoreOptionsArtifact Runtime Activity Descriptor Store Options 接口,共包含 2 个公开字段或方法。
RuntimeActivityDescriptorReference接口interface RuntimeActivityDescriptorReferenceRuntime Activity Descriptor Reference 接口,共包含 2 个公开字段或方法。
RuntimeActivityDescriptorStore接口interface RuntimeActivityDescriptorStoreRuntime Activity Descriptor Store 接口,共包含 2 个公开字段或方法。

ArtifactRuntimeActivityDescriptorStore

Persists immutable Activity descriptors outside HumanTask Events.

声明

text
export declare class ArtifactRuntimeActivityDescriptorStore implements RuntimeActivityDescriptorStore {
    constructor(options: ArtifactRuntimeActivityDescriptorStoreOptions);
    put(input: RuntimeActivityDescriptor): Promise<RuntimeActivityDescriptorReference>;
    get(reference: RuntimeActivityDescriptorReference): Promise<RuntimeActivityDescriptor>;
}

公开成员

成员种类签名说明
constructor构造函数(options: ArtifactRuntimeActivityDescriptorStoreOptions): ArtifactRuntimeActivityDescriptorStore创建该类的实例。
get方法get(reference: RuntimeActivityDescriptorReference): Promise<RuntimeActivityDescriptor>公开方法;参数与返回类型以签名列为准。
put方法put(input: RuntimeActivityDescriptor): Promise<RuntimeActivityDescriptorReference>公开方法;参数与返回类型以签名列为准。

ArtifactRuntimeActivityDescriptorStoreOptions

Artifact Runtime Activity Descriptor Store Options 接口,共包含 2 个公开字段或方法。

声明

text
export interface ArtifactRuntimeActivityDescriptorStoreOptions {
    artifacts: ArtifactStoreProvider;
    maxDescriptorBytes?: number;
}

契约成员

成员种类签名说明
artifacts属性artifacts: ArtifactStoreProvider公开属性;类型、只读和可选状态以签名列为准。
maxDescriptorBytes属性maxDescriptorBytes?: number公开属性;类型、只读和可选状态以签名列为准。

RuntimeActivityDescriptorReference

Runtime Activity Descriptor Reference 接口,共包含 2 个公开字段或方法。

声明

text
export interface RuntimeActivityDescriptorReference {
    activityDescriptorRef: string;
    activityDescriptorHash: string;
}

契约成员

成员种类签名说明
activityDescriptorHash属性activityDescriptorHash: string公开属性;类型、只读和可选状态以签名列为准。
activityDescriptorRef属性activityDescriptorRef: string公开属性;类型、只读和可选状态以签名列为准。

RuntimeActivityDescriptorStore

Runtime Activity Descriptor Store 接口,共包含 2 个公开字段或方法。

声明

text
export interface RuntimeActivityDescriptorStore {
    put(descriptor: RuntimeActivityDescriptor): Promise<RuntimeActivityDescriptorReference>;
    get(reference: RuntimeActivityDescriptorReference): Promise<RuntimeActivityDescriptor>;
}

契约成员

成员种类签名说明
get方法get(reference: RuntimeActivityDescriptorReference): Promise<RuntimeActivityDescriptor>公开方法;参数与返回类型以签名列为准。
put方法put(descriptor: RuntimeActivityDescriptor): Promise<RuntimeActivityDescriptorReference>公开方法;参数与返回类型以签名列为准。