Skip to content

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

模块用法

用于使用该功能边界的公共契约与操作。Memory server permanent migration acceptance 模块公开 1 函数、2 接口。

从包入口导入

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

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

使用要点

  • 2 个类型/接口用于应用代码、Adapter 或测试中的静态契约;请使用 import type,运行时不应依赖它们。
  • 1 个函数是该模块的直接操作入口;每个 overload 的必需/可选参数与返回类型均在下方列出。

公共导出

Symbol种类签名说明
runPermanentMemoryBehaviorAcceptance函数runPermanentMemoryBehaviorAcceptance(factory: PermanentMemoryMigrationHarnessFactory, fixtures?: readonly PermanentMemoryFailureFixture[]): Promise<PermanentMemoryBehaviorReport>Run Permanent Memory Behavior Acceptance 函数,提供 1 个公开调用签名;参数与返回类型见下表。
PermanentMemoryBehaviorFinding接口interface PermanentMemoryBehaviorFindingPermanent Memory Behavior Finding 接口,共包含 3 个公开字段或方法。
PermanentMemoryBehaviorReport接口interface PermanentMemoryBehaviorReportPermanent Memory Behavior Report 接口,共包含 3 个公开字段或方法。

runPermanentMemoryBehaviorAcceptance

Run Permanent Memory Behavior Acceptance 函数,提供 1 个公开调用签名;参数与返回类型见下表。

声明

text
export declare function runPermanentMemoryBehaviorAcceptance(factory: PermanentMemoryMigrationHarnessFactory, fixtures?: readonly PermanentMemoryFailureFixture[]): Promise<PermanentMemoryBehaviorReport>;

调用签名

text
runPermanentMemoryBehaviorAcceptance(factory: PermanentMemoryMigrationHarnessFactory, fixtures?: readonly PermanentMemoryFailureFixture[]): Promise<PermanentMemoryBehaviorReport>

参数

参数类型必需说明
factoryPermanentMemoryMigrationHarnessFactory必需参数;接受的值由类型列定义。
fixturesreadonly PermanentMemoryFailureFixture[]可选参数;接受的值由类型列定义。

返回值

  • 类型: Promise<PermanentMemoryBehaviorReport>
  • 说明: 返回值契约由上述类型定义。

PermanentMemoryBehaviorFinding

Permanent Memory Behavior Finding 接口,共包含 3 个公开字段或方法。

声明

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

契约成员

成员种类签名说明
code属性code: string公开属性;类型、只读和可选状态以签名列为准。
fixtureId属性fixtureId: string公开属性;类型、只读和可选状态以签名列为准。
message属性message: string公开属性;类型、只读和可选状态以签名列为准。

PermanentMemoryBehaviorReport

Permanent Memory Behavior Report 接口,共包含 3 个公开字段或方法。

声明

text
export interface PermanentMemoryBehaviorReport {
    passed: boolean;
    cases: number;
    findings: PermanentMemoryBehaviorFinding[];
}

契约成员

成员种类签名说明
cases属性cases: number公开属性;类型、只读和可选状态以签名列为准。
findings属性findings: PermanentMemoryBehaviorFinding[]公开属性;类型、只读和可选状态以签名列为准。
passed属性passed: boolean公开属性;类型、只读和可选状态以签名列为准。