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

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

模块用法

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

从包入口导入

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

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

使用要点

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

公共导出

Symbol	种类	签名	说明
RedisCacheStore	类	new RedisCacheStore(options: RedisCacheStoreOptions): RedisCacheStore	Redis Cache Store 类，共公开 7 个构造函数或成员；精确签名见本条目的声明与成员表。
RedisCacheClient	接口	interface RedisCacheClient	Redis Cache Client 接口，共包含 6 个公开字段或方法。
RedisCacheStoreOptions	接口	interface RedisCacheStoreOptions	Redis Cache Store Options 接口，共包含 4 个公开字段或方法。

RedisCacheStore

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

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

声明

export declare class RedisCacheStore implements CacheStore {
    constructor(options: RedisCacheStoreOptions);
    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>;
    health(): Promise<CacheStoreHealth>;
    close(): Promise<void>;
}

公开成员

成员	种类	签名	说明
clear	方法	clear(): Promise<void>	公开方法；参数与返回类型以签名列为准。
close	方法	close(): Promise<void>	公开方法；参数与返回类型以签名列为准。
constructor	构造函数	(options: RedisCacheStoreOptions): RedisCacheStore	创建该类的实例。
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>	公开方法；参数与返回类型以签名列为准。

RedisCacheClient

Redis Cache Client 接口，共包含 6 个公开字段或方法。

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

声明

export interface RedisCacheClient {
    get(key: string): Promise<string | null>;
    set(key: string, value: string, ...args: Array<string | number>): Promise<unknown>;
    del(...keys: string[]): Promise<number>;
    scan(cursor: string, ...args: Array<string | number>): Promise<[string, string[]]>;
    ping?(): Promise<string>;
    quit?(): Promise<unknown>;
}

契约成员

成员	种类	签名	说明
del	方法	del(...keys: string[]): Promise<number>	公开方法；参数与返回类型以签名列为准。
get	方法	get(key: string): Promise<string | null>	公开方法；参数与返回类型以签名列为准。
ping	方法	ping?(): Promise<string>	公开方法；参数与返回类型以签名列为准。
quit	方法	quit?(): Promise<unknown>	公开方法；参数与返回类型以签名列为准。
scan	方法	scan(cursor: string, ...args: Array<string | number>): Promise<[string, string[]]>	公开方法；参数与返回类型以签名列为准。
set	方法	set(key: string, value: string, ...args: Array<string | number>): Promise<unknown>	公开方法；参数与返回类型以签名列为准。

RedisCacheStoreOptions

Redis Cache Store Options 接口，共包含 4 个公开字段或方法。

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

声明

export interface RedisCacheStoreOptions {
    client: RedisCacheClient;
    prefix?: string;
    closeClient?: boolean;
    now?: () => number;
}

契约成员

成员	种类	签名	说明
client	属性	client: RedisCacheClient	公开属性；类型、只读和可选状态以签名列为准。
closeClient	属性	closeClient?: boolean	公开属性；类型、只读和可选状态以签名列为准。
now	方法	now?(): number	公开方法；参数与返回类型以签名列为准。
prefix	属性	prefix?: string	公开属性；类型、只读和可选状态以签名列为准。