Skip to content

@codesoul-co/hypha-memory / structured-external-mapping-store

模块用法

用于持久化并读取该边界的数据。Structured external mapping store 模块公开 1 类、1 接口。

从包入口导入

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

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

使用要点

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

公共导出

Symbol种类签名说明
StructuredExternalMemoryMappingStorenew StructuredExternalMemoryMappingStore(options: StructuredExternalMemoryMappingStoreOptions): StructuredExternalMemoryMappingStorePersistent, restart-safe mapping between Hypha memory IDs and provider IDs.
StructuredExternalMemoryMappingStoreOptions接口interface StructuredExternalMemoryMappingStoreOptionsStructured External Memory Mapping Store Options 接口,共包含 2 个公开字段或方法。

StructuredExternalMemoryMappingStore

Persistent, restart-safe mapping between Hypha memory IDs and provider IDs.

声明

text
export declare class StructuredExternalMemoryMappingStore implements ExternalMemoryMappingStore {
    readonly durability: "durable";
    constructor(options: StructuredExternalMemoryMappingStoreOptions);
    get(providerId: string, memoryId: string): Promise<ExternalMemoryMapping | null>;
    getByExternalId(providerId: string, externalId: string): Promise<ExternalMemoryMapping | null>;
    set(mapping: ExternalMemoryMapping): Promise<void>;
    list(providerId: string): Promise<ExternalMemoryMapping[]>;
}

公开成员

成员种类签名说明
constructor构造函数(options: StructuredExternalMemoryMappingStoreOptions): StructuredExternalMemoryMappingStore创建该类的实例。
durability属性readonly durability: "durable"公开属性;类型、只读和可选状态以签名列为准。
get方法get(providerId: string, memoryId: string): Promise<ExternalMemoryMapping | null>公开方法;参数与返回类型以签名列为准。
getByExternalId方法getByExternalId(providerId: string, externalId: string): Promise<ExternalMemoryMapping | null>公开方法;参数与返回类型以签名列为准。
list方法list(providerId: string): Promise<ExternalMemoryMapping[]>公开方法;参数与返回类型以签名列为准。
set方法set(mapping: ExternalMemoryMapping): Promise<void>公开方法;参数与返回类型以签名列为准。

StructuredExternalMemoryMappingStoreOptions

Structured External Memory Mapping Store Options 接口,共包含 2 个公开字段或方法。

声明

text
export interface StructuredExternalMemoryMappingStoreOptions {
    store: StructuredStoreProvider;
    table?: string;
}

契约成员

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