refactor: 重构ViewedRowPersistOptions处理扁平化问题

改成按 type 字段区分的联合类型
master^2
layhuts 2026-05-09 11:02:16 +08:00
parent 8ce773f264
commit 88d5661e0c
2 changed files with 43 additions and 54 deletions

View File

@ -55,34 +55,50 @@ export interface ViewedRowStorageAdapter {
}
/**
*
*
*/
export interface ViewedRowPersistOptions {
/**
* 'localStorage'
* - memory:
* - localStorage: 使 localStorage
* - sessionStorage: 使 sessionStorage
* - indexedDB: 使 IndexedDB TTL
* - custom:
*/
type?: 'custom' | 'indexedDB' | 'localStorage' | 'memory' | 'sessionStorage';
/** 存储 key / prefixtype 为 localStorage/sessionStorage/indexedDB 时必传) */
key?: string;
interface ViewedRowPersistBase {
/** 持久化数据的存活时间(毫秒) */
ttl?: number;
/** 最大缓存数量,超出时淘汰最早标记的 keyFIFO默认 100 */
maxSize?: number;
/** IndexedDB 数据库名称(仅 type='indexedDB' 时生效,默认 'viewed-table-db' */
dbName?: string;
/** IndexedDB 数据库版本(仅 type='indexedDB' 时生效,默认 1 */
dbVersion?: number;
/** IndexedDB 对象存储名称(仅 type='indexedDB' 时生效,默认 'viewed-table-row' */
storeName?: string;
/** 自定义存储适配器(仅 type='custom' 时生效,不传则降级为 memory */
storage?: ViewedRowStorageAdapter;
}
/**
* type
*
* - 'memory'
* - 'localStorage' 使 localStorage key
* - 'sessionStorage' 使 sessionStorage key
* - 'indexedDB' 使 IndexedDB key
* - 'custom' storage
*/
export type ViewedRowPersistOptions =
({
/** IndexedDB 数据库名称,默认 'viewed-table-db' */
dbName?: string;
/** IndexedDB 数据库版本,默认 1 */
dbVersion?: number;
/** 存储 key / prefix必传 */
key: string;
/** IndexedDB 对象存储名称,默认 'viewed-table-row' */
storeName?: string;
type: 'indexedDB';
} & ViewedRowPersistBase)
| ({
/** 存储 key必传 */
key: string;
type: 'localStorage' | 'sessionStorage';
} & ViewedRowPersistBase)
| ({
/** 自定义存储适配器(必传) */
storage: ViewedRowStorageAdapter;
type: 'custom';
} & ViewedRowPersistBase)
| (ViewedRowPersistBase & {
type: 'memory';
});
/**
* row
*/

View File

@ -54,9 +54,9 @@ function createWebStorageAdapter(
* prefix:1 { expiry, value: 1 }
*/
function createIndexedDBAdapter(
opts: ViewedRowPersistOptions,
opts: Extract<ViewedRowPersistOptions, { type: 'indexedDB' }>,
): ViewedRowStorageAdapter {
const prefix = opts.key || 'viewed';
const prefix = opts.key;
const manager = new StorageManager({
driver: new IndexedDBDriver({
dbName: opts.dbName || 'viewed-table-db',
@ -69,16 +69,11 @@ function createIndexedDBAdapter(
return {
async getKeys() {
try {
// 通过 StorageManager 的 driver 获取所有 key再逐条读取自动过滤过期
const allKeys = (await (manager as any).driver.keys()) as string[];
const fullPrefix = prefix ? `${prefix}-` : '';
const prefixedKeys = allKeys.filter((k: string) =>
k.startsWith(fullPrefix),
);
// 通过 StorageManager 获取当前前缀下所有 key再逐条读取自动过滤过期
const shortKeys = await manager.keys();
const results: Array<number | string> = [];
for (const fullKey of prefixedKeys) {
const shortKey = fullKey.replace(fullPrefix, '');
for (const shortKey of shortKeys) {
const value = await manager.getItem<number | string>(shortKey);
if (value !== null) {
results.push(value);
@ -124,43 +119,21 @@ function createStorageAdapter(
return createWebStorageAdapter('localStorage', persist);
}
const {type = 'localStorage'} = persist;
switch (type) {
switch (persist.type) {
case 'custom': {
if (!persist.storage) {
// 没有提供 storage 适配器,降级为 memory
return null;
}
// 用户自定义适配器,解除 Vue 响应式代理
return toRaw(persist.storage);
}
case 'indexedDB': {
if (!persist.key) {
console.warn('[viewedRow] persist.key is required for indexedDB type');
return null;
}
return createIndexedDBAdapter(persist);
}
case 'localStorage': {
if (!persist.key) {
console.warn(
'[viewedRow] persist.key is required for localStorage type',
);
return null;
}
return createWebStorageAdapter('localStorage', persist.key, persist.ttl);
}
case 'memory': {
return null;
}
case 'sessionStorage': {
if (!persist.key) {
console.warn(
'[viewedRow] persist.key is required for sessionStorage type',
);
return null;
}
return createWebStorageAdapter(
'sessionStorage',
persist.key,