@codesoul-co/hypha-core / modules/runtime/runtime-checkpoint-store

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

Using this module

Use the Runtime checkpoint store module for persisting and reading data at this boundary. It exports 1 class, 2 functions.

Import from the package entrypoint

import {
  InMemoryRuntimeCheckpointStore,
  runtimeCheckpointChecksum,
  verifyRuntimeCheckpointChecksum,
} from '@codesoul-co/hypha-core';

Usage patterns

• The module exposes 1 class as constructable runtime implementations. Each symbol entry lists its constructor and public methods.
• The module exposes 2 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.

Public exports

Symbol	Kind	Signature	Description
InMemoryRuntimeCheckpointStore	class	new InMemoryRuntimeCheckpointStore(): InMemoryRuntimeCheckpointStore	In Memory Runtime Checkpoint Store class with 5 public constructor or member entries; its exact declarations are listed below.
runtimeCheckpointChecksum	function	runtimeCheckpointChecksum(record: Omit<RuntimeCheckpointRecord, "checksum"> | RuntimeCheckpointRecord): string	Runtime Checkpoint Checksum function with 1 public call signature; parameters and return types are listed below.
verifyRuntimeCheckpointChecksum	function	verifyRuntimeCheckpointChecksum(record: RuntimeCheckpointRecord): void	Verify Runtime Checkpoint Checksum function with 1 public call signature; parameters and return types are listed below.

InMemoryRuntimeCheckpointStore

In Memory Runtime Checkpoint Store class with 5 public constructor or member entries; its exact declarations are listed below.

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

Declaration

export declare class InMemoryRuntimeCheckpointStore implements RuntimeCheckpointStore {
    put(input: RuntimeCheckpointRecord, idempotencyKey: string): Promise<RuntimeCheckpointPutResult>;
    get(scope: RuntimeScope, checkpointId: string): Promise<RuntimeCheckpointRecord | null>;
    latest(scope: RuntimeScope): Promise<RuntimeCheckpointRecord | null>;
    list(scope: RuntimeScope, limit?: number): Promise<RuntimeCheckpointRecord[]>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(): InMemoryRuntimeCheckpointStore	Creates an instance of this class.
get	method	get(scope: RuntimeScope, checkpointId: string): Promise<RuntimeCheckpointRecord | null>	Public method; parameters and return type are shown in the signature.
latest	method	latest(scope: RuntimeScope): Promise<RuntimeCheckpointRecord | null>	Public method; parameters and return type are shown in the signature.
list	method	list(scope: RuntimeScope, limit?: number): Promise<RuntimeCheckpointRecord[]>	Public method; parameters and return type are shown in the signature.
put	method	put(input: RuntimeCheckpointRecord, idempotencyKey: string): Promise<RuntimeCheckpointPutResult>	Public method; parameters and return type are shown in the signature.

runtimeCheckpointChecksum

Runtime Checkpoint Checksum function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { runtimeCheckpointChecksum } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/runtime-checkpoint-store

Declaration

export declare function runtimeCheckpointChecksum(record: Omit<RuntimeCheckpointRecord, 'checksum'> | RuntimeCheckpointRecord): string;

Call signature

runtimeCheckpointChecksum(record: Omit<RuntimeCheckpointRecord, "checksum"> | RuntimeCheckpointRecord): string

Parameters

Parameter	Type	Required	Description
record	RuntimeCheckpointRecord | Omit<RuntimeCheckpointRecord, "checksum">	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: string
• Description: The return contract is defined by the type shown above.

verifyRuntimeCheckpointChecksum

Verify Runtime Checkpoint Checksum function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { verifyRuntimeCheckpointChecksum } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/runtime-checkpoint-store

Declaration

export declare function verifyRuntimeCheckpointChecksum(record: RuntimeCheckpointRecord): void;

Call signature

verifyRuntimeCheckpointChecksum(record: RuntimeCheckpointRecord): void

Parameters

Parameter	Type	Required	Description
record	RuntimeCheckpointRecord	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: void
• Description: Returns no value.