Skip to content

@codesoul-co/hypha-core / modules/runtime/runtime-timer-worker

模块用法

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

从包入口导入

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

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

使用要点

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

公共导出

Symbol种类签名说明
DurableRuntimeTimerWorkernew DurableRuntimeTimerWorker(options: DurableRuntimeTimerWorkerOptions): DurableRuntimeTimerWorkerDurable Runtime Timer Worker 类,共公开 2 个构造函数或成员;精确签名见本条目的声明与成员表。
DurableRuntimeTimerWorkerOptions接口interface DurableRuntimeTimerWorkerOptionsDurable Runtime Timer Worker Options 接口,共包含 11 个公开字段或方法。

DurableRuntimeTimerWorker

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

声明

text
export declare class DurableRuntimeTimerWorker {
    constructor(options: DurableRuntimeTimerWorkerOptions);
    sweep(input: RuntimeTimerSweepRequest): Promise<RuntimeTimerSweepResult>;
}

公开成员

成员种类签名说明
constructor构造函数(options: DurableRuntimeTimerWorkerOptions): DurableRuntimeTimerWorker创建该类的实例。
sweep方法sweep(input: RuntimeTimerSweepRequest): Promise<RuntimeTimerSweepResult>公开方法;参数与返回类型以签名列为准。

DurableRuntimeTimerWorkerOptions

Durable Runtime Timer Worker Options 接口,共包含 11 个公开字段或方法。

声明

text
export interface DurableRuntimeTimerWorkerOptions {
    events: EventRuntime;
    projections: ProjectionEngine;
    projectionStore: ProjectionStore<RuntimeOrchestrationProjection>;
    runLeases: RunLeaseStore;
    renewalIntervalMs?: number;
    wait?: (delayMs: number, signal: AbortSignal) => Promise<void>;
    onLeaseRenewalFailure?: (error: unknown, runId: string) => void;
    operationalTelemetry?: RuntimeOperationalTelemetry;
    monotonicNow?: () => number;
    now?: () => string;
    nextId?: (namespace: string) => string;
}

契约成员

成员种类签名说明
events属性events: EventRuntime公开属性;类型、只读和可选状态以签名列为准。
monotonicNow方法monotonicNow?(): number公开方法;参数与返回类型以签名列为准。
nextId方法nextId?(namespace: string): string公开方法;参数与返回类型以签名列为准。
now方法now?(): string公开方法;参数与返回类型以签名列为准。
onLeaseRenewalFailure方法onLeaseRenewalFailure?(error: unknown, runId: string): void公开方法;参数与返回类型以签名列为准。
operationalTelemetry属性operationalTelemetry?: RuntimeOperationalTelemetry公开属性;类型、只读和可选状态以签名列为准。
projections属性projections: ProjectionEngine公开属性;类型、只读和可选状态以签名列为准。
projectionStore属性projectionStore: ProjectionStore<RuntimeOrchestrationProjection>公开属性;类型、只读和可选状态以签名列为准。
renewalIntervalMs属性renewalIntervalMs?: number公开属性;类型、只读和可选状态以签名列为准。
runLeases属性runLeases: RunLeaseStore公开属性;类型、只读和可选状态以签名列为准。
wait方法wait?(delayMs: number, signal: AbortSignal): Promise<void>公开方法;参数与返回类型以签名列为准。