@codesoul-co/hypha-memory / memory-utils

• 包索引: @codesoul-co/hypha-memory
• 源码: packages/memory/src/memory-utils.ts
• 导出数: 7

模块用法

用于使用该功能边界的公共契约与操作。Memory utils 模块公开 7 函数。

从包入口导入

import {
  hashMemoryContent,
  hashMemoryScope,
  isNormalizedMemoryError,
  memoryError,
  normalizeMemoryError,
  sha256,
  stableStringify,
} from '@codesoul-co/hypha-memory';

使用要点

• 7 个函数是该模块的直接操作入口；每个 overload 的必需/可选参数与返回类型均在下方列出。

公共导出

Symbol	种类	签名	说明
hashMemoryContent	函数	hashMemoryContent(content: unknown): string	Hash Memory Content 函数，提供 1 个公开调用签名；参数与返回类型见下表。
hashMemoryScope	函数	hashMemoryScope(scope: ManagedMemoryScope): string	Hash Memory Scope 函数，提供 1 个公开调用签名；参数与返回类型见下表。
isNormalizedMemoryError	函数	isNormalizedMemoryError(value: unknown): value is NormalizedMemoryError	Is Normalized Memory Error 函数，提供 1 个公开调用签名；参数与返回类型见下表。
memoryError	函数	memoryError(code: NormalizedMemoryError["code"], message: string, retryable?: boolean, details?: Record<string, unknown>): NormalizedMemoryError	Memory Error 函数，提供 1 个公开调用签名；参数与返回类型见下表。
normalizeMemoryError	函数	normalizeMemoryError(error: unknown, fallbackCode?: NormalizedMemoryError["code"]): NormalizedMemoryError	Normalize Memory Error 函数，提供 1 个公开调用签名；参数与返回类型见下表。
sha256	函数	sha256(value: unknown): string	Sha256 函数，提供 1 个公开调用签名；参数与返回类型见下表。
stableStringify	函数	stableStringify(value: unknown): string	Stable Stringify 函数，提供 1 个公开调用签名；参数与返回类型见下表。

hashMemoryContent

Hash Memory Content 函数，提供 1 个公开调用签名；参数与返回类型见下表。

• 种类: 函数
• 导入: import { hashMemoryContent } from '@codesoul-co/hypha-memory';
• 源码模块: memory-utils

声明

export declare function hashMemoryContent(content: unknown): string;

调用签名

hashMemoryContent(content: unknown): string

参数

参数	类型	必需	说明
content	unknown	是	必需参数；接受的值由类型列定义。

返回值

• 类型: string
• 说明: 返回值契约由上述类型定义。

hashMemoryScope

Hash Memory Scope 函数，提供 1 个公开调用签名；参数与返回类型见下表。

• 种类: 函数
• 导入: import { hashMemoryScope } from '@codesoul-co/hypha-memory';
• 源码模块: memory-utils

声明

export declare function hashMemoryScope(scope: ManagedMemoryScope): string;

调用签名

hashMemoryScope(scope: ManagedMemoryScope): string

参数

参数	类型	必需	说明
scope	ManagedMemoryScope	是	必需参数；接受的值由类型列定义。

返回值

• 类型: string
• 说明: 返回值契约由上述类型定义。

isNormalizedMemoryError

Is Normalized Memory Error 函数，提供 1 个公开调用签名；参数与返回类型见下表。

• 种类: 函数
• 导入: import { isNormalizedMemoryError } from '@codesoul-co/hypha-memory';
• 源码模块: memory-utils

声明

export declare function isNormalizedMemoryError(value: unknown): value is NormalizedMemoryError;

调用签名

isNormalizedMemoryError(value: unknown): value is NormalizedMemoryError

参数

参数	类型	必需	说明
value	unknown	是	必需参数；接受的值由类型列定义。

返回值

• 类型: value is NormalizedMemoryError
• 说明: 返回值契约由上述类型定义。

memoryError

Memory Error 函数，提供 1 个公开调用签名；参数与返回类型见下表。

• 种类: 函数
• 导入: import { memoryError } from '@codesoul-co/hypha-memory';
• 源码模块: memory-utils

声明

export declare function memoryError(code: NormalizedMemoryError['code'], message: string, retryable?: boolean, details?: Record<string, unknown>): NormalizedMemoryError;

调用签名

memoryError(code: NormalizedMemoryError["code"], message: string, retryable?: boolean, details?: Record<string, unknown>): NormalizedMemoryError

参数

参数	类型	必需	说明
code	"MEMORY_INVALID_INPUT" | "MEMORY_EXTRACTION_SOURCE_UNAVAILABLE" | "MEMORY_EXTRACTION_FAILED" | "MEMORY_EXTRACTION_CURSOR_CONFLICT" | "MEMORY_MAINTENANCE_CONFLICT" | "MEMORY_RANKING_FAILED" | "MEMORY_IDEMPOTENCY_CONFLICT" | "MEMORY_SCOPE_DENIED" | "MEMORY_PERMISSION_DENIED" | "MEMORY_NOT_FOUND" | "MEMORY_REVISION_CONFLICT" | "MEMORY_PROVIDER_NOT_INSTALLED" | "MEMORY_PROVIDER_UNAVAILABLE" | "MEMORY_PROVIDER_TIMEOUT"...	是	必需参数；接受的值由类型列定义。
message	string	是	必需参数；接受的值由类型列定义。
retryable	boolean	否	可选参数；接受的值由类型列定义。
details	Record<string, unknown>	否	可选参数；接受的值由类型列定义。

返回值

• 类型: NormalizedMemoryError
• 说明: 返回值契约由上述类型定义。

normalizeMemoryError

Normalize Memory Error 函数，提供 1 个公开调用签名；参数与返回类型见下表。

• 种类: 函数
• 导入: import { normalizeMemoryError } from '@codesoul-co/hypha-memory';
• 源码模块: memory-utils

声明

export declare function normalizeMemoryError(error: unknown, fallbackCode?: NormalizedMemoryError['code']): NormalizedMemoryError;

调用签名

normalizeMemoryError(error: unknown, fallbackCode?: NormalizedMemoryError["code"]): NormalizedMemoryError

参数

参数	类型	必需	说明
error	unknown	是	必需参数；接受的值由类型列定义。
fallbackCode	"MEMORY_INVALID_INPUT" | "MEMORY_EXTRACTION_SOURCE_UNAVAILABLE" | "MEMORY_EXTRACTION_FAILED" | "MEMORY_EXTRACTION_CURSOR_CONFLICT" | "MEMORY_MAINTENANCE_CONFLICT" | "MEMORY_RANKING_FAILED" | "MEMORY_IDEMPOTENCY_CONFLICT" | "MEMORY_SCOPE_DENIED" | "MEMORY_PERMISSION_DENIED" | "MEMORY_NOT_FOUND" | "MEMORY_REVISION_CONFLICT" | "MEMORY_PROVIDER_NOT_INSTALLED" | "MEMORY_PROVIDER_UNAVAILABLE" | "MEMORY_PROVIDER_TIMEOUT"...	否	可选参数；接受的值由类型列定义。

返回值

• 类型: NormalizedMemoryError
• 说明: 返回值契约由上述类型定义。

sha256

Sha256 函数，提供 1 个公开调用签名；参数与返回类型见下表。

• 种类: 函数
• 导入: import { sha256 } from '@codesoul-co/hypha-memory';
• 源码模块: memory-utils

声明

export declare function sha256(value: unknown): string;

调用签名

sha256(value: unknown): string

参数

参数	类型	必需	说明
value	unknown	是	必需参数；接受的值由类型列定义。

返回值

• 类型: string
• 说明: 返回值契约由上述类型定义。

stableStringify

Stable Stringify 函数，提供 1 个公开调用签名；参数与返回类型见下表。

• 种类: 函数
• 导入: import { stableStringify } from '@codesoul-co/hypha-memory';
• 源码模块: memory-utils

声明

export declare function stableStringify(value: unknown): string;

调用签名

stableStringify(value: unknown): string

参数

参数	类型	必需	说明
value	unknown	是	必需参数；接受的值由类型列定义。

返回值

• 类型: string
• 说明: 返回值契约由上述类型定义。