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

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

Using this module

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

Import from the package entrypoint

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

import type {
  RuntimeQueryServiceOptions,
} 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
RuntimeQueryService	class	new RuntimeQueryService(options: RuntimeQueryServiceOptions): RuntimeQueryService	Runtime Query Service class with 6 public constructor or member entries; its exact declarations are listed below.
RuntimeQueryServiceOptions	interface	interface RuntimeQueryServiceOptions	Runtime Query Service Options interface with 4 public fields or methods.

RuntimeQueryService

Runtime Query Service class with 6 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { RuntimeQueryService } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/runtime-query-service

Declaration

export declare class RuntimeQueryService implements RuntimeQueryServiceContract {
    constructor(options: RuntimeQueryServiceOptions);
    getRun(input: RuntimeQueryRequest): Promise<RuntimeRunView | null>;
    getFSM(input: RuntimeQueryRequest): Promise<RuntimeOrchestrationProjection | null>;
    getTimeline(input: RuntimeTimelineRequest): Promise<RuntimeTimelineResult>;
    getPendingWaits(input: RuntimeQueryRequest): Promise<RuntimePendingWaitProjection[]>;
    explainState(input: RuntimeQueryRequest): Promise<RuntimeStateExplanation | null>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(options: RuntimeQueryServiceOptions): RuntimeQueryService	Creates an instance of this class.
explainState	method	explainState(input: RuntimeQueryRequest): Promise<RuntimeStateExplanation | null>	Public method; parameters and return type are shown in the signature.
getFSM	method	getFSM(input: RuntimeQueryRequest): Promise<RuntimeOrchestrationProjection | null>	Public method; parameters and return type are shown in the signature.
getPendingWaits	method	getPendingWaits(input: RuntimeQueryRequest): Promise<RuntimePendingWaitProjection[]>	Public method; parameters and return type are shown in the signature.
getRun	method	getRun(input: RuntimeQueryRequest): Promise<RuntimeRunView | null>	Public method; parameters and return type are shown in the signature.
getTimeline	method	getTimeline(input: RuntimeTimelineRequest): Promise<RuntimeTimelineResult>	Public method; parameters and return type are shown in the signature.

RuntimeQueryServiceOptions

Runtime Query Service Options interface with 4 public fields or methods.

• Kind: interface
• Import: import type { RuntimeQueryServiceOptions } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/runtime-query-service

Declaration

export interface RuntimeQueryServiceOptions {
    events: Pick<EventRuntime, 'read' | 'getStreamHead'>;
    projections: ProjectionEngine;
    projectionStore: ProjectionStore<RuntimeOrchestrationProjection>;
    now?: () => string;
}

Contract members

Member	Kind	Signature	Description
events	property	events: Pick<EventRuntime, "read" | "getStreamHead">	Public property; its type, readonly modifier and optionality are shown in the signature.
now	method	now?(): string	Public method; parameters and return type 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.