@codesoul-co/hypha-serving-cache / cache-manager

• 包索引: @codesoul-co/hypha-serving-cache
• 源码: packages/serving-cache/src/cache-manager.ts
• 导出数: 3

模块用法

用于读写或协调缓存状态。Cache manager 模块公开 2 类、1 接口。

从包入口导入

import {
  CacheEntryTooLargeError,
  ServingCacheManager,
} from '@codesoul-co/hypha-serving-cache';

import type {
  ServingCacheManagerOptions,
} from '@codesoul-co/hypha-serving-cache';

使用要点

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

公共导出

Symbol	种类	签名	说明
CacheEntryTooLargeError	类	new CacheEntryTooLargeError(sizeBytes: number, maxEntryBytes: number): CacheEntryTooLargeError	Cache Entry Too Large Error 类，共公开 11 个构造函数或成员；精确签名见本条目的声明与成员表。
ServingCacheManager	类	new ServingCacheManager(options: ServingCacheManagerOptions): ServingCacheManager	Serving Cache Manager 类，共公开 8 个构造函数或成员；精确签名见本条目的声明与成员表。
ServingCacheManagerOptions	接口	interface ServingCacheManagerOptions	Serving Cache Manager Options 接口，共包含 3 个公开字段或方法。

CacheEntryTooLargeError

Cache Entry Too Large Error 类，共公开 11 个构造函数或成员；精确签名见本条目的声明与成员表。

• 种类: 类
• 导入: import { CacheEntryTooLargeError } from '@codesoul-co/hypha-serving-cache';
• 源码模块: cache-manager

声明

export declare class CacheEntryTooLargeError extends Error {
    readonly sizeBytes: number;
    readonly maxEntryBytes: number;
    readonly code = "CACHE_ENTRY_TOO_LARGE";
    constructor(sizeBytes: number, maxEntryBytes: number);
}

公开成员

成员	种类	签名	说明
cause	属性	cause?: unknown	公开属性；类型、只读和可选状态以签名列为准。
code	属性	readonly code: "CACHE_ENTRY_TOO_LARGE"	公开属性；类型、只读和可选状态以签名列为准。
constructor	构造函数	(sizeBytes: number, maxEntryBytes: number): CacheEntryTooLargeError	创建该类的实例。
maxEntryBytes	属性	readonly maxEntryBytes: number	公开属性；类型、只读和可选状态以签名列为准。
message	属性	message: string	公开属性；类型、只读和可选状态以签名列为准。
name	属性	name: string	公开属性；类型、只读和可选状态以签名列为准。
sizeBytes	属性	readonly sizeBytes: number	公开属性；类型、只读和可选状态以签名列为准。
stack	属性	stack?: string	公开属性；类型、只读和可选状态以签名列为准。
static captureStackTrace	方法	static captureStackTrace(targetObject: object, constructorOpt?: Function): void	Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called. js const myObject = {}; Error.captureStackTrace(myObject); myObject.stack; // Similar to `new Error().stack` The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}. The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace. The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance: js function a() { b(); } function b() { c(); } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit; // Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error; } a();
static prepareStackTrace	方法	static prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any	公开方法；参数与返回类型以签名列为准。
static stackTraceLimit	属性	static stackTraceLimit: number	The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)). The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

ServingCacheManager

Serving Cache Manager 类，共公开 8 个构造函数或成员；精确签名见本条目的声明与成员表。

• 种类: 类
• 导入: import { ServingCacheManager } from '@codesoul-co/hypha-serving-cache';
• 源码模块: cache-manager

声明

export declare class ServingCacheManager {
    readonly policy: CachePolicy;
    constructor(options: ServingCacheManagerOptions);
    keyFor(input: LLMCacheKeyInput): string;
    get<T>(key: string): Promise<CacheEntry<T> | null>;
    lookup<T>(key: string): Promise<CacheLookupResult<T>>;
    set<T>(key: string, value: T, metadata: CacheMetadata, ttlMs?: number | undefined): Promise<void>;
    delete(key: string): Promise<void>;
    clear(): Promise<void>;
}

公开成员

成员	种类	签名	说明
clear	方法	clear(): Promise<void>	公开方法；参数与返回类型以签名列为准。
constructor	构造函数	(options: ServingCacheManagerOptions): ServingCacheManager	创建该类的实例。
delete	方法	delete(key: string): Promise<void>	公开方法；参数与返回类型以签名列为准。
get	方法	get<T>(key: string): Promise<CacheEntry<T> | null>	公开方法；参数与返回类型以签名列为准。
keyFor	方法	keyFor(input: LLMCacheKeyInput): string	公开方法；参数与返回类型以签名列为准。
lookup	方法	lookup<T>(key: string): Promise<CacheLookupResult<T>>	公开方法；参数与返回类型以签名列为准。
policy	属性	readonly policy: CachePolicy	公开属性；类型、只读和可选状态以签名列为准。
set	方法	set<T>(key: string, value: T, metadata: CacheMetadata, ttlMs?: number | undefined): Promise<void>	公开方法；参数与返回类型以签名列为准。

ServingCacheManagerOptions

Serving Cache Manager Options 接口，共包含 3 个公开字段或方法。

• 种类: 接口
• 导入: import type { ServingCacheManagerOptions } from '@codesoul-co/hypha-serving-cache';
• 源码模块: cache-manager

声明

export interface ServingCacheManagerOptions {
    store: CacheStore;
    policy?: Partial<CachePolicy>;
    now?: () => number;
}

契约成员

成员	种类	签名	说明
now	方法	now?(): number	公开方法；参数与返回类型以签名列为准。
policy	属性	policy?: Partial<CachePolicy>	公开属性；类型、只读和可选状态以签名列为准。
store	属性	store: CacheStore<unknown>	公开属性；类型、只读和可选状态以签名列为准。