@codesoul-co/hypha-memory / native-maintenance

• Package index: @codesoul-co/hypha-memory
• Source: packages/memory/src/native-maintenance.ts
• Exports: 2

Using this module

Use the Native maintenance module for using the public contracts and operations for this capability boundary. It exports 1 class, 1 type.

Import from the package entrypoint

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

import type {
  MemoryMaintenanceApplier,
} from '@codesoul-co/hypha-memory';

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
DeterministicMemoryMaintenancePlanner	class	new DeterministicMemoryMaintenancePlanner(applyDecision?: MemoryMaintenanceApplier | undefined, now?: () => string): DeterministicMemoryMaintenancePlanner	Deterministic Memory Maintenance Planner class with 4 public constructor or member entries; its exact declarations are listed below.
MemoryMaintenanceApplier	type	type MemoryMaintenanceApplier = (request: MemoryMaintenanceApplyRequest) => Promise<ManagedMemoryWriteResult>	Public type alias for Memory Maintenance Applier; the declaration contains its complete type expression.

DeterministicMemoryMaintenancePlanner

Deterministic Memory Maintenance Planner class with 4 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { DeterministicMemoryMaintenancePlanner } from '@codesoul-co/hypha-memory';
• Source module: native-maintenance

Declaration

export declare class DeterministicMemoryMaintenancePlanner implements MemoryMaintenancePlanner {
    constructor(applyDecision?: MemoryMaintenanceApplier | undefined, now?: () => string);
    plan(request: MemoryMaintenancePlanRequest): Promise<MemoryMaintenanceDecision>;
    apply(request: MemoryMaintenanceApplyRequest): Promise<ManagedMemoryWriteResult>;
    explain(decisionId: string): Promise<MemoryMaintenanceDecision | null>;
}

Public members

Member	Kind	Signature	Description
apply	method	apply(request: MemoryMaintenanceApplyRequest): Promise<ManagedMemoryWriteResult>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(applyDecision?: MemoryMaintenanceApplier | undefined, now?: () => string): DeterministicMemoryMaintenancePlanner	Creates an instance of this class.
explain	method	explain(decisionId: string): Promise<MemoryMaintenanceDecision | null>	Public method; parameters and return type are shown in the signature.
plan	method	plan(request: MemoryMaintenancePlanRequest): Promise<MemoryMaintenanceDecision>	Public method; parameters and return type are shown in the signature.

MemoryMaintenanceApplier

Public type alias for Memory Maintenance Applier; the declaration contains its complete type expression.

• Kind: type
• Import: import type { MemoryMaintenanceApplier } from '@codesoul-co/hypha-memory';
• Source module: native-maintenance

Declaration

export type MemoryMaintenanceApplier = (request: MemoryMaintenanceApplyRequest) => Promise<ManagedMemoryWriteResult>;