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

• Package index: @codesoul-co/hypha-core
• Source: packages/core/src/modules/runtime/runtime-timer-worker.ts
• Exports: 2

Using this module

Use the Runtime timer worker module for executing runtime behavior at this boundary. It exports 1 class, 1 interface.

Import from the package entrypoint

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

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

Usage patterns

• Use the 1 type/interface export as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.
• The module exposes 1 class as constructable runtime implementations. Each symbol entry lists its constructor and public methods.

Public exports

Symbol	Kind	Signature	Description
DurableRuntimeTimerWorker	class	new DurableRuntimeTimerWorker(options: DurableRuntimeTimerWorkerOptions): DurableRuntimeTimerWorker	Durable Runtime Timer Worker class with 2 public constructor or member entries; its exact declarations are listed below.
DurableRuntimeTimerWorkerOptions	interface	interface DurableRuntimeTimerWorkerOptions	Durable Runtime Timer Worker Options interface with 11 public fields or methods.

DurableRuntimeTimerWorker

Durable Runtime Timer Worker class with 2 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { DurableRuntimeTimerWorker } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/runtime-timer-worker

Declaration

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

Public members

Member	Kind	Signature	Description
constructor	constructor	(options: DurableRuntimeTimerWorkerOptions): DurableRuntimeTimerWorker	Creates an instance of this class.
sweep	method	sweep(input: RuntimeTimerSweepRequest): Promise<RuntimeTimerSweepResult>	Public method; parameters and return type are shown in the signature.

DurableRuntimeTimerWorkerOptions

Durable Runtime Timer Worker Options interface with 11 public fields or methods.

• Kind: interface
• Import: import type { DurableRuntimeTimerWorkerOptions } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/runtime-timer-worker

Declaration

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;
}

Contract members

Member	Kind	Signature	Description
events	property	events: EventRuntime	Public property; its type, readonly modifier and optionality are shown in the signature.
monotonicNow	method	monotonicNow?(): number	Public method; parameters and return type are shown in the signature.
nextId	method	nextId?(namespace: string): string	Public method; parameters and return type are shown in the signature.
now	method	now?(): string	Public method; parameters and return type are shown in the signature.
onLeaseRenewalFailure	method	onLeaseRenewalFailure?(error: unknown, runId: string): void	Public method; parameters and return type are shown in the signature.
operationalTelemetry	property	operationalTelemetry?: RuntimeOperationalTelemetry	Public property; its type, readonly modifier and optionality are shown in the signature.
projections	property	projections: ProjectionEngine	Public property; its type, readonly modifier and optionality are shown in the signature.
projectionStore	property	projectionStore: ProjectionStore<RuntimeOrchestrationProjection>	Public property; its type, readonly modifier and optionality are shown in the signature.
renewalIntervalMs	property	renewalIntervalMs?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
runLeases	property	runLeases: RunLeaseStore	Public property; its type, readonly modifier and optionality are shown in the signature.
wait	method	wait?(delayMs: number, signal: AbortSignal): Promise<void>	Public method; parameters and return type are shown in the signature.