@codesoul-co/hypha-core / modules/runtime/runtime-activity-descriptor-store

• Package index: @codesoul-co/hypha-core
• Source: packages/core/src/modules/runtime/runtime-activity-descriptor-store.ts
• Exports: 4

Using this module

Use the Runtime activity descriptor store module for persisting and reading data at this boundary. It exports 1 class, 3 interfaces.

Import from the package entrypoint

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

import type {
  ArtifactRuntimeActivityDescriptorStoreOptions,
  RuntimeActivityDescriptorReference,
  RuntimeActivityDescriptorStore,
} from '@codesoul-co/hypha-core';

Usage patterns

• Use the 3 type/interface exports 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
ArtifactRuntimeActivityDescriptorStore	class	new ArtifactRuntimeActivityDescriptorStore(options: ArtifactRuntimeActivityDescriptorStoreOptions): ArtifactRuntimeActivityDescriptorStore	Persists immutable Activity descriptors outside HumanTask Events.
ArtifactRuntimeActivityDescriptorStoreOptions	interface	interface ArtifactRuntimeActivityDescriptorStoreOptions	Artifact Runtime Activity Descriptor Store Options interface with 2 public fields or methods.
RuntimeActivityDescriptorReference	interface	interface RuntimeActivityDescriptorReference	Runtime Activity Descriptor Reference interface with 2 public fields or methods.
RuntimeActivityDescriptorStore	interface	interface RuntimeActivityDescriptorStore	Runtime Activity Descriptor Store interface with 2 public fields or methods.

ArtifactRuntimeActivityDescriptorStore

Persists immutable Activity descriptors outside HumanTask Events.

• Kind: class
• Import: import { ArtifactRuntimeActivityDescriptorStore } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/runtime-activity-descriptor-store

Declaration

export declare class ArtifactRuntimeActivityDescriptorStore implements RuntimeActivityDescriptorStore {
    constructor(options: ArtifactRuntimeActivityDescriptorStoreOptions);
    put(input: RuntimeActivityDescriptor): Promise<RuntimeActivityDescriptorReference>;
    get(reference: RuntimeActivityDescriptorReference): Promise<RuntimeActivityDescriptor>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(options: ArtifactRuntimeActivityDescriptorStoreOptions): ArtifactRuntimeActivityDescriptorStore	Creates an instance of this class.
get	method	get(reference: RuntimeActivityDescriptorReference): Promise<RuntimeActivityDescriptor>	Public method; parameters and return type are shown in the signature.
put	method	put(input: RuntimeActivityDescriptor): Promise<RuntimeActivityDescriptorReference>	Public method; parameters and return type are shown in the signature.

ArtifactRuntimeActivityDescriptorStoreOptions

Artifact Runtime Activity Descriptor Store Options interface with 2 public fields or methods.

• Kind: interface
• Import: import type { ArtifactRuntimeActivityDescriptorStoreOptions } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/runtime-activity-descriptor-store

Declaration

export interface ArtifactRuntimeActivityDescriptorStoreOptions {
    artifacts: ArtifactStoreProvider;
    maxDescriptorBytes?: number;
}

Contract members

Member	Kind	Signature	Description
artifacts	property	artifacts: ArtifactStoreProvider	Public property; its type, readonly modifier and optionality are shown in the signature.
maxDescriptorBytes	property	maxDescriptorBytes?: number	Public property; its type, readonly modifier and optionality are shown in the signature.

RuntimeActivityDescriptorReference

Runtime Activity Descriptor Reference interface with 2 public fields or methods.

• Kind: interface
• Import: import type { RuntimeActivityDescriptorReference } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/runtime-activity-descriptor-store

Declaration

export interface RuntimeActivityDescriptorReference {
    activityDescriptorRef: string;
    activityDescriptorHash: string;
}

Contract members

Member	Kind	Signature	Description
activityDescriptorHash	property	activityDescriptorHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
activityDescriptorRef	property	activityDescriptorRef: string	Public property; its type, readonly modifier and optionality are shown in the signature.

RuntimeActivityDescriptorStore

Runtime Activity Descriptor Store interface with 2 public fields or methods.

• Kind: interface
• Import: import type { RuntimeActivityDescriptorStore } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/runtime-activity-descriptor-store

Declaration

export interface RuntimeActivityDescriptorStore {
    put(descriptor: RuntimeActivityDescriptor): Promise<RuntimeActivityDescriptorReference>;
    get(reference: RuntimeActivityDescriptorReference): Promise<RuntimeActivityDescriptor>;
}

Contract members

Member	Kind	Signature	Description
get	method	get(reference: RuntimeActivityDescriptorReference): Promise<RuntimeActivityDescriptor>	Public method; parameters and return type are shown in the signature.
put	method	put(descriptor: RuntimeActivityDescriptor): Promise<RuntimeActivityDescriptorReference>	Public method; parameters and return type are shown in the signature.