LocalStorageCollectionConfig

接口:LocalStorageCollectionConfig<TExplicit, TSchema, TFallback>

定义于:packages/db/src/local-storage.ts:61

localStorage collection 选项的配置接口

备注

类型解析遵循优先级顺序

  1. 如果您通过泛型参数提供显式类型,则会使用该类型
  2. 如果未提供显式类型但提供了 schema,则会推断出 schema 的输出类型
  3. 如果未提供显式类型也未提供 schema,则会使用后备类型

您应该提供一个显式类型 OR 一个 schema,但不要两者都提供,因为它们会冲突。

类型参数

TExplicit = 未知

集合中项目的显式类型(最高优先级)

TSchema 继承自 StandardSchemaV1 = never

用于验证和类型推断的模式类型(第二优先级)

TFallback 继承自 object = Record<string, unknown>

如果没有提供显式类型或模式类型,则回退类型

属性

getKey()

ts
getKey: (item) => string | number;
getKey: (item) => string | number;

定义于:packages/db/src/local-storage.ts:88

参数

item

ResolveType

Returns (返回)

string | number


id?

ts
optional id: string;
optional id: string;

定义于:packages/db/src/local-storage.ts:86

Collection 标识符(如果未提供,则默认为 "local-collection:{storageKey}")


onDelete()?

ts
optional onDelete: (params) => Promise<any>;
optional onDelete: (params) => Promise<any>;

定义于:packages/db/src/local-storage.ts:114

删除操作之前调用的可选异步处理函数

参数

params

DeleteMutationFnParams<ResolveType<TExplicit, TSchema, TFallback>>

包含事务和集合信息的对象

Returns (返回)

Promise<any>

解析为任何值的 Promise


onInsert()?

ts
optional onInsert: (params) => Promise<any>;
optional onInsert: (params) => Promise<any>;

定义于:packages/db/src/local-storage.ts:96

插入操作之前调用的可选异步处理函数

参数

params

InsertMutationFnParams<ResolveType<TExplicit, TSchema, TFallback>>

包含事务和集合信息的对象

Returns (返回)

Promise<any>

解析为任何值的 Promise


onUpdate()?

ts
optional onUpdate: (params) => Promise<any>;
optional onUpdate: (params) => Promise<any>;

定义于:packages/db/src/local-storage.ts:105

更新操作之前调用的可选异步处理函数

参数

params

UpdateMutationFnParams<ResolveType<TExplicit, TSchema, TFallback>>

包含事务和集合信息的对象

Returns (返回)

Promise<any>

解析为任何值的 Promise


schema?

ts
optional schema: TSchema;
optional schema: TSchema;

定义于:packages/db/src/local-storage.ts:87


storage?

ts
optional storage: StorageApi;
optional storage: StorageApi;

定义于:packages/db/src/local-storage.ts:75

要使用的 Storage API(默认为 window.localStorage)。可以是任何实现 Storage 接口的对象(例如 sessionStorage)。


storageEventApi?

ts
optional storageEventApi: StorageEventApi;
optional storageEventApi: StorageEventApi;

定义于:packages/db/src/local-storage.ts:81

用于跨标签页同步的 Storage 事件 API(默认为 window)。可以是任何实现了 storage 事件的 addEventListener/removeEventListener 的对象。


storageKey

ts
storageKey: string;
storageKey: string;

定义于:packages/db/src/local-storage.ts:69

用于在 localStorage/sessionStorage 中存储 collection 数据的键


sync?

ts
optional sync: SyncConfig<ResolveType<TExplicit, TSchema, TFallback>, string | number>;
optional sync: SyncConfig<ResolveType<TExplicit, TSchema, TFallback>, string | number>;

定义于:packages/db/src/local-storage.ts:89

我们的合作伙伴
Code Rabbit
Electric
Prisma
订阅 Bytes

您的每周 JavaScript 资讯。每周一免费发送给超过 10 万开发者。

Bytes

无垃圾邮件。您可以随时取消订阅。

订阅 Bytes

您的每周 JavaScript 资讯。每周一免费发送给超过 10 万开发者。

Bytes

无垃圾邮件。您可以随时取消订阅。