electricCollectionOptions
函数：electricCollectionOptions()
ts
function electricCollectionOptions<TExplicit, TSchema, TFallback>(config): object
function electricCollectionOptions<TExplicit, TSchema, TFallback>(config): object
定义于：packages/electric-db-collection/src/electric.ts:285
为标准的 Collection 创建 Electric collection 选项
类型参数
• TExplicit extends Row<unknown> = Row<unknown>
集合中项目的显式类型（最高优先级）
• TSchema extends StandardSchemaV1<unknown, unknown> = never
用于验证和类型推断的模式类型（第二优先级）
• TFallback extends Row<unknown> = Row<unknown>
如果没有提供显式类型或模式类型，则回退类型
参数
config
ElectricCollectionConfig<TExplicit, TSchema, TFallback>
Electric collection 的配置选项
Returns (返回)
object
带有工具的 Collection 选项
getKey()
ts
getKey: (item) => string | number;
getKey: (item) => string | number;
参数
item
ResolveType
Returns (返回)
string | number
id?
ts
optional id: string;
optional id: string;
所有标准的 Collection 配置属性
onDelete
ts
onDelete:
| undefined
| (params) => Promise<{
txid: number | number[];
}> = wrappedOnDelete;
onDelete:
| undefined
| (params) => Promise<{
txid: number | number[];
}> = wrappedOnDelete;
onInsert
ts
onInsert:
| undefined
| (params) => Promise<{
txid: number | number[];
}> = wrappedOnInsert;
onInsert:
| undefined
| (params) => Promise<{
txid: number | number[];
}> = wrappedOnInsert;
onUpdate
ts
onUpdate:
| undefined
| (params) => Promise<{
txid: number | number[];
}> = wrappedOnUpdate;
onUpdate:
| undefined
| (params) => Promise<{
txid: number | number[];
}> = wrappedOnUpdate;
schema?
ts
optional schema: TSchema;
optional schema: TSchema;
sync
ts
sync: SyncConfig<ResolveType<TExplicit, TSchema, TFallback>, string | number>;
sync: SyncConfig<ResolveType<TExplicit, TSchema, TFallback>, string | number>;
utils
ts
utils: object;
utils: object;
utils.awaitTxId
ts
awaitTxId: AwaitTxIdFn;
awaitTxId: AwaitTxIdFn;
我们的合作伙伴
订阅 Bytes
您的每周 JavaScript 资讯。每周一免费发送给超过 10 万开发者。
订阅 Bytes
您的每周 JavaScript 资讯。每周一免费发送给超过 10 万开发者。