HYPHA / DOCS

简体中文

English

简体中文

English

@codesoul-co/hypha-memory / memory-projection-invalidation ​

模块用法 ​

用于使用该功能边界的公共契约与操作。Memory projection invalidation 模块公开 3 类、5 接口、1 类型。

从包入口导入 ​

ts
import {
  InMemoryMemoryMutationGenerationStore,
  MemoryProjectionInvalidationCoordinator,
  MemorySearchCacheInvalidationTarget,
} from '@codesoul-co/hypha-memory';

import type {
  MemoryMutationGenerationStore,
  MemoryProjectionInvalidationPort,
  MemoryProjectionInvalidationReceipt,
  MemoryProjectionInvalidationRequest,
  MemoryProjectionInvalidationTarget,
  MemoryProjectionInvalidationReason,
} from '@codesoul-co/hypha-memory';

使用要点 ​

  • 6 个类型/接口用于应用代码、Adapter 或测试中的静态契约；请使用 import type，运行时不应依赖它们。
  • 3 个类提供可实例化的运行时实现；构造参数与公开方法在各自条目中完整列出。

公共导出 ​

Symbol种类签名说明
InMemoryMemoryMutationGenerationStore类new InMemoryMemoryMutationGenerationStore(): InMemoryMemoryMutationGenerationStoreIn Memory Memory Mutation Generation Store 类，共公开 3 个构造函数或成员；精确签名见本条目的声明与成员表。
MemoryProjectionInvalidationCoordinator类new MemoryProjectionInvalidationCoordinator(generations: MemoryMutationGenerationStore, targets: readonly MemoryProjectionInvalidationTarget[]): MemoryProjectionInvalidationCoordinatorMemory Projection Invalidation Coordinator 类，共公开 2 个构造函数或成员；精确签名见本条目的声明与成员表。
MemorySearchCacheInvalidationTarget类new MemorySearchCacheInvalidationTarget(store: MemorySearchCacheStore, id?: string): MemorySearchCacheInvalidationTargetMemory Search Cache Invalidation Target 类，共公开 3 个构造函数或成员；精确签名见本条目的声明与成员表。
MemoryMutationGenerationStore接口interface MemoryMutationGenerationStoreMemory Mutation Generation Store 接口，共包含 2 个公开字段或方法。
MemoryProjectionInvalidationPort接口interface MemoryProjectionInvalidationPortMemory Projection Invalidation Port 接口，共包含 1 个公开字段或方法。
MemoryProjectionInvalidationReceipt接口interface MemoryProjectionInvalidationReceiptMemory Projection Invalidation Receipt 接口，共包含 5 个公开字段或方法。
MemoryProjectionInvalidationRequest接口interface MemoryProjectionInvalidationRequestMemory Projection Invalidation Request 接口，共包含 5 个公开字段或方法。
MemoryProjectionInvalidationTarget接口interface MemoryProjectionInvalidationTargetMemory Projection Invalidation Target 接口，共包含 2 个公开字段或方法。
MemoryProjectionInvalidationReason类型type MemoryProjectionInvalidationReason = 'updated' | 'deleted'Memory Projection Invalidation Reason 公共类型别名；完整类型表达式见声明。

InMemoryMemoryMutationGenerationStore ​

In Memory Memory Mutation Generation Store 类，共公开 3 个构造函数或成员；精确签名见本条目的声明与成员表。

声明 ​

text
export declare class InMemoryMemoryMutationGenerationStore implements MemoryMutationGenerationStore {
    current(scopeHash: string): Promise<string>;
    advance(scopeHash: string, operationId: string): Promise<string>;
}

公开成员 ​

成员种类签名说明
advance方法advance(scopeHash: string, operationId: string): Promise<string>公开方法；参数与返回类型以签名列为准。
constructor构造函数(): InMemoryMemoryMutationGenerationStore创建该类的实例。
current方法current(scopeHash: string): Promise<string>公开方法；参数与返回类型以签名列为准。

MemoryProjectionInvalidationCoordinator ​

Memory Projection Invalidation Coordinator 类，共公开 2 个构造函数或成员；精确签名见本条目的声明与成员表。

声明 ​

text
export declare class MemoryProjectionInvalidationCoordinator implements MemoryProjectionInvalidationPort {
    constructor(generations: MemoryMutationGenerationStore, targets: readonly MemoryProjectionInvalidationTarget[]);
    invalidate(request: MemoryProjectionInvalidationRequest): Promise<MemoryProjectionInvalidationReceipt>;
}

公开成员 ​

成员种类签名说明
constructor构造函数(generations: MemoryMutationGenerationStore, targets: readonly MemoryProjectionInvalidationTarget[]): MemoryProjectionInvalidationCoordinator创建该类的实例。
invalidate方法invalidate(request: MemoryProjectionInvalidationRequest): Promise<MemoryProjectionInvalidationReceipt>公开方法；参数与返回类型以签名列为准。

MemorySearchCacheInvalidationTarget ​

Memory Search Cache Invalidation Target 类，共公开 3 个构造函数或成员；精确签名见本条目的声明与成员表。

声明 ​

text
export declare class MemorySearchCacheInvalidationTarget implements MemoryProjectionInvalidationTarget {
    readonly id: string;
    constructor(store: MemorySearchCacheStore, id?: string);
    invalidateScope(scopeHash: string): Promise<number>;
}

公开成员 ​

成员种类签名说明
constructor构造函数(store: MemorySearchCacheStore, id?: string): MemorySearchCacheInvalidationTarget创建该类的实例。
id属性readonly id: string公开属性；类型、只读和可选状态以签名列为准。
invalidateScope方法invalidateScope(scopeHash: string): Promise<number>公开方法；参数与返回类型以签名列为准。

MemoryMutationGenerationStore ​

Memory Mutation Generation Store 接口，共包含 2 个公开字段或方法。

声明 ​

text
export interface MemoryMutationGenerationStore {
    current(scopeHash: string): Promise<string>;
    advance(scopeHash: string, operationId: string): Promise<string>;
}

契约成员 ​

成员种类签名说明
advance方法advance(scopeHash: string, operationId: string): Promise<string>公开方法；参数与返回类型以签名列为准。
current方法current(scopeHash: string): Promise<string>公开方法；参数与返回类型以签名列为准。

MemoryProjectionInvalidationPort ​

Memory Projection Invalidation Port 接口，共包含 1 个公开字段或方法。

声明 ​

text
export interface MemoryProjectionInvalidationPort {
    invalidate(request: MemoryProjectionInvalidationRequest): Promise<MemoryProjectionInvalidationReceipt>;
}

契约成员 ​

成员种类签名说明
invalidate方法invalidate(request: MemoryProjectionInvalidationRequest): Promise<MemoryProjectionInvalidationReceipt>公开方法；参数与返回类型以签名列为准。

MemoryProjectionInvalidationReceipt ​

Memory Projection Invalidation Receipt 接口，共包含 5 个公开字段或方法。

  • 种类: 接口
  • 导入: import type { MemoryProjectionInvalidationReceipt } from '@codesoul-co/hypha-memory';
  • 源码模块: memory-projection-invalidation

声明 ​

text
export interface MemoryProjectionInvalidationReceipt {
    operationId: string;
    scopeHash: string;
    mutationGeneration: string;
    reason: MemoryProjectionInvalidationReason;
    targets: Array<{
        id: string;
        invalidatedEntries: number;
    }>;
}

契约成员 ​

成员种类签名说明
mutationGeneration属性mutationGeneration: string公开属性；类型、只读和可选状态以签名列为准。
operationId属性operationId: string公开属性；类型、只读和可选状态以签名列为准。
reason属性reason: MemoryProjectionInvalidationReason公开属性；类型、只读和可选状态以签名列为准。
scopeHash属性scopeHash: string公开属性；类型、只读和可选状态以签名列为准。
targets属性targets: { id: string; invalidatedEntries: number; }[]公开属性；类型、只读和可选状态以签名列为准。

MemoryProjectionInvalidationRequest ​

Memory Projection Invalidation Request 接口，共包含 5 个公开字段或方法。

  • 种类: 接口
  • 导入: import type { MemoryProjectionInvalidationRequest } from '@codesoul-co/hypha-memory';
  • 源码模块: memory-projection-invalidation

声明 ​

text
export interface MemoryProjectionInvalidationRequest {
    operationId: string;
    scope: ManagedMemoryScope;
    reason: MemoryProjectionInvalidationReason;
    memoryIds: string[];
    memoryVersionIds?: string[];
}

契约成员 ​

成员种类签名说明
memoryIds属性memoryIds: string[]公开属性；类型、只读和可选状态以签名列为准。
memoryVersionIds属性memoryVersionIds?: string[]公开属性；类型、只读和可选状态以签名列为准。
operationId属性operationId: string公开属性；类型、只读和可选状态以签名列为准。
reason属性reason: MemoryProjectionInvalidationReason公开属性；类型、只读和可选状态以签名列为准。
scope属性scope: ManagedMemoryScope公开属性；类型、只读和可选状态以签名列为准。

MemoryProjectionInvalidationTarget ​

Memory Projection Invalidation Target 接口，共包含 2 个公开字段或方法。

  • 种类: 接口
  • 导入: import type { MemoryProjectionInvalidationTarget } from '@codesoul-co/hypha-memory';
  • 源码模块: memory-projection-invalidation

声明 ​

text
export interface MemoryProjectionInvalidationTarget {
    readonly id: string;
    invalidateScope(scopeHash: string, mutationGeneration: string): Promise<number>;
}

契约成员 ​

成员种类签名说明
id属性readonly id: string公开属性；类型、只读和可选状态以签名列为准。
invalidateScope方法invalidateScope(scopeHash: string, mutationGeneration: string): Promise<number>公开方法；参数与返回类型以签名列为准。

MemoryProjectionInvalidationReason ​

Memory Projection Invalidation Reason 公共类型别名；完整类型表达式见声明。

  • 种类: 类型
  • 导入: import type { MemoryProjectionInvalidationReason } from '@codesoul-co/hypha-memory';
  • 源码模块: memory-projection-invalidation

声明 ​

text
export type MemoryProjectionInvalidationReason = 'updated' | 'deleted';