Skip to content

@codesoul-co/hypha-memory / memory-server-redis-migration-acceptance

Using this module

Use the Memory server redis migration acceptance module for using the public contracts and operations for this capability boundary. It exports 1 function, 2 interfaces.

Import from the package entrypoint

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

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

Usage patterns

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

Public exports

SymbolKindSignatureDescription
runRedisWorkingMemoryBehaviorAcceptancefunctionrunRedisWorkingMemoryBehaviorAcceptance(factory: WorkingMemoryMigrationHarnessFactory, cases?: readonly RedisWorkingMemoryBoundaryCase[]): Promise<RedisWorkingMemoryBehaviorReport>Run Redis Working Memory Behavior Acceptance function with 1 public call signature; parameters and return types are listed below.
RedisWorkingMemoryBehaviorFindinginterfaceinterface RedisWorkingMemoryBehaviorFindingRedis Working Memory Behavior Finding interface with 3 public fields or methods.
RedisWorkingMemoryBehaviorReportinterfaceinterface RedisWorkingMemoryBehaviorReportRedis Working Memory Behavior Report interface with 3 public fields or methods.

runRedisWorkingMemoryBehaviorAcceptance

Run Redis Working Memory Behavior Acceptance function with 1 public call signature; parameters and return types are listed below.

Declaration

text
export declare function runRedisWorkingMemoryBehaviorAcceptance(factory: WorkingMemoryMigrationHarnessFactory, cases?: readonly RedisWorkingMemoryBoundaryCase[]): Promise<RedisWorkingMemoryBehaviorReport>;

Call signature

text
runRedisWorkingMemoryBehaviorAcceptance(factory: WorkingMemoryMigrationHarnessFactory, cases?: readonly RedisWorkingMemoryBoundaryCase[]): Promise<RedisWorkingMemoryBehaviorReport>

Parameters

ParameterTypeRequiredDescription
factoryWorkingMemoryMigrationHarnessFactoryYesRequired parameter; accepted values are defined by the type column.
casesreadonly RedisWorkingMemoryBoundaryCase[]NoOptional parameter; accepted values are defined by the type column.

Returns

  • Type: Promise<RedisWorkingMemoryBehaviorReport>
  • Description: The return contract is defined by the type shown above.

RedisWorkingMemoryBehaviorFinding

Redis Working Memory Behavior Finding interface with 3 public fields or methods.

Declaration

text
export interface RedisWorkingMemoryBehaviorFinding {
    fixtureId: string;
    code: string;
    message: string;
}

Contract members

MemberKindSignatureDescription
codepropertycode: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
fixtureIdpropertyfixtureId: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
messagepropertymessage: stringPublic property; its type, readonly modifier and optionality are shown in the signature.

RedisWorkingMemoryBehaviorReport

Redis Working Memory Behavior Report interface with 3 public fields or methods.

Declaration

text
export interface RedisWorkingMemoryBehaviorReport {
    passed: boolean;
    cases: number;
    findings: RedisWorkingMemoryBehaviorFinding[];
}

Contract members

MemberKindSignatureDescription
casespropertycases: numberPublic property; its type, readonly modifier and optionality are shown in the signature.
findingspropertyfindings: RedisWorkingMemoryBehaviorFinding[]Public property; its type, readonly modifier and optionality are shown in the signature.
passedpropertypassed: booleanPublic property; its type, readonly modifier and optionality are shown in the signature.