Skip to content

@codesoul-co/hypha-serving-cache / stores/memory-store

模块用法

用于持久化并读取该边界的数据。Memory store 模块公开 2 类。

从包入口导入

ts
import {
  MemoryCacheStore,
  NoopCacheStore,
} from '@codesoul-co/hypha-serving-cache';

使用要点

  • 2 个类提供可实例化的运行时实现;构造参数与公开方法在各自条目中完整列出。

公共导出

Symbol种类签名说明
MemoryCacheStorenew MemoryCacheStore(options?: { maxEntries?: number; maxBytes?: number; }): MemoryCacheStoreMemory Cache Store 类,共公开 8 个构造函数或成员;精确签名见本条目的声明与成员表。
NoopCacheStorenew NoopCacheStore(): NoopCacheStoreNoop Cache Store 类,共公开 5 个构造函数或成员;精确签名见本条目的声明与成员表。

MemoryCacheStore

Memory Cache Store 类,共公开 8 个构造函数或成员;精确签名见本条目的声明与成员表。

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

声明

text
export declare class MemoryCacheStore implements CacheStore {
    constructor(options?: {
            maxEntries?: number;
            maxBytes?: number;
        });
    get<T>(key: string): Promise<CacheEntry<T> | null>;
    set<T>(key: string, entry: CacheEntry<T>): Promise<void>;
    delete(key: string): Promise<void>;
    clear(): Promise<void>;
    touch(key: string): Promise<void>;
    stats(): Promise<CacheStoreStats>;
    health(): Promise<CacheStoreHealth>;
}

公开成员

成员种类签名说明
clear方法clear(): Promise<void>公开方法;参数与返回类型以签名列为准。
constructor构造函数(options?: { maxEntries?: number; maxBytes?: number; }): MemoryCacheStore创建该类的实例。
delete方法delete(key: string): Promise<void>公开方法;参数与返回类型以签名列为准。
get方法get<T>(key: string): Promise<CacheEntry<T> | null>公开方法;参数与返回类型以签名列为准。
health方法health(): Promise<CacheStoreHealth>公开方法;参数与返回类型以签名列为准。
set方法set<T>(key: string, entry: CacheEntry<T>): Promise<void>公开方法;参数与返回类型以签名列为准。
stats方法stats(): Promise<CacheStoreStats>公开方法;参数与返回类型以签名列为准。
touch方法touch(key: string): Promise<void>公开方法;参数与返回类型以签名列为准。

NoopCacheStore

Noop Cache Store 类,共公开 5 个构造函数或成员;精确签名见本条目的声明与成员表。

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

声明

text
export declare class NoopCacheStore implements CacheStore {
    get<T>(): Promise<CacheEntry<T> | null>;
    set<T>(): Promise<void>;
    delete(): Promise<void>;
    clear(): Promise<void>;
}

公开成员

成员种类签名说明
clear方法clear(): Promise<void>公开方法;参数与返回类型以签名列为准。
constructor构造函数(): NoopCacheStore创建该类的实例。
delete方法delete(): Promise<void>公开方法;参数与返回类型以签名列为准。
get方法get<T>(): Promise<CacheEntry<T> | null>公开方法;参数与返回类型以签名列为准。
set方法set<T>(): Promise<void>公开方法;参数与返回类型以签名列为准。