LocalOnlyCollectionConfig

接口:LocalOnlyCollectionConfig<TExplicit, TSchema, TFallback, TKey>

定义于:packages/db/src/local-only.ts:27

仅本地集合选项的配置接口

备注

类型解析遵循优先级顺序

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

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

类型参数

TExplicit = 未知

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

TSchema 继承自 StandardSchemaV1 = never

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

TFallback extends Record<string, unknown> = Record<string, unknown>

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

TKey extends string | number = string | number

getKey 返回的键的类型

属性

getKey()

ts
getKey: (item) => TKey;
getKey: (item) => TKey;

定义于:packages/db/src/local-only.ts:38

参数

item

ResolveType<TExplicit, TSchema, TFallback>

Returns (返回)

TKey


id?

ts
optional id: string;
optional id: string;

定义于:packages/db/src/local-only.ts:36

标准集合配置属性


initialData?

ts
optional initialData: ResolveType<TExplicit, TSchema, TFallback>[];
optional initialData: ResolveType<TExplicit, TSchema, TFallback>[];

定义于:packages/db/src/local-only.ts:44

创建时用于填充集合的可选初始数据。此数据将在初始同步过程中应用。


onDelete()?

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

定义于:packages/db/src/local-only.ts:77

删除操作后调用的可选异步处理函数。

参数

params

DeleteMutationFnParams<ResolveType<TExplicit, TSchema, TFallback>, TKey, LocalOnlyCollectionUtils>

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

Returns (返回)

Promise<any>

解析为任何值的 Promise


onInsert()?

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

定义于:packages/db/src/local-only.ts:51

插入操作后调用的可选异步处理函数。

参数

params

InsertMutationFnParams<ResolveType<TExplicit, TSchema, TFallback>, TKey, LocalOnlyCollectionUtils>

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

Returns (返回)

Promise<any>

解析为任何值的 Promise


onUpdate()?

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

定义于:packages/db/src/local-only.ts:64

更新操作后调用的可选异步处理函数。

参数

params

UpdateMutationFnParams<ResolveType<TExplicit, TSchema, TFallback>, TKey, LocalOnlyCollectionUtils>

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

Returns (返回)

Promise<any>

解析为任何值的 Promise


schema?

ts
optional schema: TSchema;
optional schema: TSchema;

定义于:packages/db/src/local-only.ts:37

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

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

Bytes

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

订阅 Bytes

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

Bytes

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