@codesoul-co/hypha-adapters-local / runtime-checkpoint-store

• Package index: @codesoul-co/hypha-adapters-local
• Source: packages/adapters-local/src/runtime-checkpoint-store.ts
• Exports: 2

Using this module

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

Import from the package entrypoint

import {
  SQLiteRuntimeCheckpointStore,
} from '@codesoul-co/hypha-adapters-local';

import type {
  SQLiteRuntimeCheckpointStoreOptions,
} from '@codesoul-co/hypha-adapters-local';

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
SQLiteRuntimeCheckpointStore	class	new SQLiteRuntimeCheckpointStore(options: SQLiteRuntimeCheckpointStoreOptions): SQLiteRuntimeCheckpointStore	SQLite Runtime Checkpoint Store class with 6 public constructor or member entries; its exact declarations are listed below.
SQLiteRuntimeCheckpointStoreOptions	interface	interface SQLiteRuntimeCheckpointStoreOptions	SQLite Runtime Checkpoint Store Options interface with 2 public fields or methods.

SQLiteRuntimeCheckpointStore

SQLite Runtime Checkpoint Store class with 6 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { SQLiteRuntimeCheckpointStore } from '@codesoul-co/hypha-adapters-local';
• Source module: runtime-checkpoint-store

Declaration

export declare class SQLiteRuntimeCheckpointStore implements RuntimeCheckpointStore {
    constructor(options: SQLiteRuntimeCheckpointStoreOptions);
    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[]>;
    close(): void;
}

Public members

Member	Kind	Signature	Description
close	method	close(): void	Public method; parameters and return type are shown in the signature.
constructor	constructor	(options: SQLiteRuntimeCheckpointStoreOptions): SQLiteRuntimeCheckpointStore	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.

SQLiteRuntimeCheckpointStoreOptions

SQLite Runtime Checkpoint Store Options interface with 2 public fields or methods.

• Kind: interface
• Import: import type { SQLiteRuntimeCheckpointStoreOptions } from '@codesoul-co/hypha-adapters-local';
• Source module: runtime-checkpoint-store

Declaration

export interface SQLiteRuntimeCheckpointStoreOptions {
    filename: string;
    now?: () => string;
}

Contract members

Member	Kind	Signature	Description
filename	property	filename: string	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.