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

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

Using this module

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

Import from the package entrypoint

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

import type {
  RuntimeCancellationServiceOptions,
} 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
RuntimeCancellationService	class	new RuntimeCancellationService(options: RuntimeCancellationServiceOptions): RuntimeCancellationService	Runtime Cancellation Service class with 2 public constructor or member entries; its exact declarations are listed below.
RuntimeCancellationServiceOptions	interface	interface RuntimeCancellationServiceOptions	Runtime Cancellation Service Options interface with 9 public fields or methods.

RuntimeCancellationService

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

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

Declaration

export declare class RuntimeCancellationService {
    constructor(options: RuntimeCancellationServiceOptions);
    cancel(input: RuntimeCancelCommand): Promise<RuntimeCancelResult>;
}

Public members

Member	Kind	Signature	Description
cancel	method	cancel(input: RuntimeCancelCommand): Promise<RuntimeCancelResult>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(options: RuntimeCancellationServiceOptions): RuntimeCancellationService	Creates an instance of this class.

RuntimeCancellationServiceOptions

Runtime Cancellation Service Options interface with 9 public fields or methods.

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

Declaration

export interface RuntimeCancellationServiceOptions {
    events: EventRuntime;
    projections: ProjectionEngine;
    projectionStore: ProjectionStore<RuntimeOrchestrationProjection>;
    runLeases: RunLeaseStore;
    commands: Pick<SessionQueue, 'cancelPending'>;
    activities: RuntimeActivityCancellationPort;
    children: RuntimeChildRunCancellationPort;
    now?: () => string;
    nextId?: (namespace: string) => string;
}

Contract members

Member	Kind	Signature	Description
activities	property	activities: RuntimeActivityCancellationPort	Public property; its type, readonly modifier and optionality are shown in the signature.
children	property	children: RuntimeChildRunCancellationPort	Public property; its type, readonly modifier and optionality are shown in the signature.
commands	property	commands: Pick<SessionQueue, "cancelPending">	Public property; its type, readonly modifier and optionality are shown in the signature.
events	property	events: EventRuntime	Public property; its type, readonly modifier and optionality 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.
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.
runLeases	property	runLeases: RunLeaseStore	Public property; its type, readonly modifier and optionality are shown in the signature.