Skip to content

@codesoul-co/hypha-core / modules/runtime/runtime-checkpoint-service

模块用法

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

从包入口导入

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

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

使用要点

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

公共导出

Symbol种类签名说明
RuntimeCheckpointServicenew RuntimeCheckpointService(options: RuntimeCheckpointServiceOptions): RuntimeCheckpointServiceRuntime Checkpoint Service 类,共公开 3 个构造函数或成员;精确签名见本条目的声明与成员表。
RuntimeCheckpointServiceOptions接口interface RuntimeCheckpointServiceOptionsRuntime Checkpoint Service Options 接口,共包含 7 个公开字段或方法。

RuntimeCheckpointService

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

声明

text
export declare class RuntimeCheckpointService {
    constructor(options: RuntimeCheckpointServiceOptions);
    create(input: RuntimeCheckpointCreateCommand): Promise<RuntimeCheckpointCreateResult>;
    load(input: RuntimeCheckpointLoadRequest): Promise<RuntimeCheckpointLoadResult | null>;
}

公开成员

成员种类签名说明
constructor构造函数(options: RuntimeCheckpointServiceOptions): RuntimeCheckpointService创建该类的实例。
create方法create(input: RuntimeCheckpointCreateCommand): Promise<RuntimeCheckpointCreateResult>公开方法;参数与返回类型以签名列为准。
load方法load(input: RuntimeCheckpointLoadRequest): Promise<RuntimeCheckpointLoadResult | null>公开方法;参数与返回类型以签名列为准。

RuntimeCheckpointServiceOptions

Runtime Checkpoint Service Options 接口,共包含 7 个公开字段或方法。

声明

text
export interface RuntimeCheckpointServiceOptions {
    events: EventRuntime;
    projections: ProjectionEngine;
    projectionStore: ProjectionStore<RuntimeOrchestrationProjection>;
    checkpoints: RuntimeCheckpointStore;
    runLeases: RunLeaseStore;
    now?: () => string;
    nextId?: (namespace: string) => string;
}

契约成员

成员种类签名说明
checkpoints属性checkpoints: RuntimeCheckpointStore公开属性;类型、只读和可选状态以签名列为准。
events属性events: EventRuntime公开属性;类型、只读和可选状态以签名列为准。
nextId方法nextId?(namespace: string): string公开方法;参数与返回类型以签名列为准。
now方法now?(): string公开方法;参数与返回类型以签名列为准。
projections属性projections: ProjectionEngine公开属性;类型、只读和可选状态以签名列为准。
projectionStore属性projectionStore: ProjectionStore<RuntimeOrchestrationProjection>公开属性;类型、只读和可选状态以签名列为准。
runLeases属性runLeases: RunLeaseStore公开属性;类型、只读和可选状态以签名列为准。