@codesoul-co/hypha-memory / bounded-recovery

• Package index: @codesoul-co/hypha-memory
• Source: packages/memory/src/bounded-recovery.ts
• Exports: 5

Using this module

Use the Bounded recovery module for handling bounded recovery, retry, or degradation. It exports 2 functions, 2 interfaces, 1 type.

Import from the package entrypoint

import {
  createMemoryFailureFingerprint,
  resolveBoundedMemoryRecovery,
} from '@codesoul-co/hypha-memory';

import type {
  BoundedMemoryRecoveryOutcome,
  MemoryRecoveryBudget,
  MemoryRunRecoveryState,
} from '@codesoul-co/hypha-memory';

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 2 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.

Public exports

Symbol	Kind	Signature	Description
createMemoryFailureFingerprint	function	createMemoryFailureFingerprint(failure: RecoveryFailure): string	Create Memory Failure Fingerprint function with 1 public call signature; parameters and return types are listed below.
resolveBoundedMemoryRecovery	function	resolveBoundedMemoryRecovery(failure: RecoveryFailure, budget: MemoryRecoveryBudget): BoundedMemoryRecoveryOutcome	Resolve Bounded Memory Recovery function with 1 public call signature; parameters and return types are listed below.
BoundedMemoryRecoveryOutcome	interface	interface BoundedMemoryRecoveryOutcome	Bounded Memory Recovery Outcome interface with 7 public fields or methods.
MemoryRecoveryBudget	interface	interface MemoryRecoveryBudget	Memory Recovery Budget interface with 5 public fields or methods.
MemoryRunRecoveryState	type	type MemoryRunRecoveryState = 'degraded' | 'waiting' | 'review' | 'quarantined' | 'failed'	Public type alias for Memory Run Recovery State; the declaration contains its complete type expression.

createMemoryFailureFingerprint

Create Memory Failure Fingerprint function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { createMemoryFailureFingerprint } from '@codesoul-co/hypha-memory';
• Source module: bounded-recovery

Declaration

export declare function createMemoryFailureFingerprint(failure: RecoveryFailure): string;

Call signature

createMemoryFailureFingerprint(failure: RecoveryFailure): string

Parameters

Parameter	Type	Required	Description
failure	RecoveryFailure	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.

resolveBoundedMemoryRecovery

Resolve Bounded Memory Recovery function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { resolveBoundedMemoryRecovery } from '@codesoul-co/hypha-memory';
• Source module: bounded-recovery

Declaration

export declare function resolveBoundedMemoryRecovery(failure: RecoveryFailure, budget: MemoryRecoveryBudget): BoundedMemoryRecoveryOutcome;

Call signature

resolveBoundedMemoryRecovery(failure: RecoveryFailure, budget: MemoryRecoveryBudget): BoundedMemoryRecoveryOutcome

Parameters

Parameter	Type	Required	Description
failure	RecoveryFailure	Yes	Required parameter; accepted values are defined by the type column.
budget	MemoryRecoveryBudget	Yes	Required parameter; accepted values are defined by the type column.

Returns

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

BoundedMemoryRecoveryOutcome

Bounded Memory Recovery Outcome interface with 7 public fields or methods.

• Kind: interface
• Import: import type { BoundedMemoryRecoveryOutcome } from '@codesoul-co/hypha-memory';
• Source module: bounded-recovery

Declaration

export interface BoundedMemoryRecoveryOutcome {
    state: MemoryRunRecoveryState;
    strategy: ReturnType<typeof adviseMemoryRecovery>['strategy'];
    retryAllowed: boolean;
    boundedEmptyResultAllowed: boolean;
    failureFingerprint: string;
    reason: string;
    nextAttempt?: number;
}

Contract members

Member	Kind	Signature	Description
boundedEmptyResultAllowed	property	boundedEmptyResultAllowed: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
failureFingerprint	property	failureFingerprint: string	Public property; its type, readonly modifier and optionality are shown in the signature.
nextAttempt	property	nextAttempt?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
reason	property	reason: string	Public property; its type, readonly modifier and optionality are shown in the signature.
retryAllowed	property	retryAllowed: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
state	property	state: MemoryRunRecoveryState	Public property; its type, readonly modifier and optionality are shown in the signature.
strategy	property	strategy: "fail" | "retry" | "human_review" | "reconcile" | "fallback" | "degrade" | "compensate" | "wait" | "quarantine" | "cancel"	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryRecoveryBudget

Memory Recovery Budget interface with 5 public fields or methods.

• Kind: interface
• Import: import type { MemoryRecoveryBudget } from '@codesoul-co/hypha-memory';
• Source module: bounded-recovery

Declaration

export interface MemoryRecoveryBudget {
    maxAttempts: number;
    attemptsUsed: number;
    deadline?: string;
    now?: string;
    seenFailureFingerprints?: string[];
}

Contract members

Member	Kind	Signature	Description
attemptsUsed	property	attemptsUsed: number	Public property; its type, readonly modifier and optionality are shown in the signature.
deadline	property	deadline?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
maxAttempts	property	maxAttempts: number	Public property; its type, readonly modifier and optionality are shown in the signature.
now	property	now?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
seenFailureFingerprints	property	seenFailureFingerprints?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryRunRecoveryState

Public type alias for Memory Run Recovery State; the declaration contains its complete type expression.

• Kind: type
• Import: import type { MemoryRunRecoveryState } from '@codesoul-co/hypha-memory';
• Source module: bounded-recovery

Declaration

export type MemoryRunRecoveryState = 'degraded' | 'waiting' | 'review' | 'quarantined' | 'failed';