函数：localStorageCollectionOptions()

function localStorageCollectionOptions<TExplicit, TSchema, TFallback>(config): object

function localStorageCollectionOptions<TExplicit, TSchema, TFallback>(config): object

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

为标准 Collection 创建 localStorage collection options

此函数创建一个 collection，该 collection 将数据持久化到 localStorage/sessionStorage，并通过 storage 事件在浏览器标签页之间同步更改。

类型参数

• TExplicit = 未知

集合中项目的显式类型（最高优先级）

• TSchema extends StandardSchemaV1<unknown, unknown> = never

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

• TFallback extends object = Record<string, unknown>

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

参数

config

LocalStorageCollectionConfig<TExplicit, TSchema, TFallback>

localStorage collection 的配置选项

Returns (返回)

object

包含 clearStorage 和 getStorageSize 工具的 collection 选项

getKey()

getKey: (item) => string | number;

getKey: (item) => string | number;

参数

item

ResolveType

Returns (返回)

string | number

id

id: string = collectionId;

id: string = collectionId;

onDelete()

onDelete: (params) => Promise<any> = wrappedOnDelete;

onDelete: (params) => Promise<any> = wrappedOnDelete;

参数

params

DeleteMutationFnParams<ResolveType<TExplicit, TSchema, TFallback>>

Returns (返回)

Promise<any>

onInsert()

onInsert: (params) => Promise<any> = wrappedOnInsert;

onInsert: (params) => Promise<any> = wrappedOnInsert;

参数

params

InsertMutationFnParams<ResolveType<TExplicit, TSchema, TFallback>>

Returns (返回)

Promise<any>

onUpdate()

onUpdate: (params) => Promise<any> = wrappedOnUpdate;

onUpdate: (params) => Promise<any> = wrappedOnUpdate;

参数

params

UpdateMutationFnParams<ResolveType<TExplicit, TSchema, TFallback>>

Returns (返回)

Promise<any>

schema?

optional schema: TSchema;

optional schema: TSchema;

sync

sync: SyncConfig<ResolveType<TExplicit, TSchema, TFallback>, string | number> & object;

sync: SyncConfig<ResolveType<TExplicit, TSchema, TFallback>, string | number> & object;

类型声明

manualTrigger()?

optional manualTrigger: () => void;

optional manualTrigger: () => void;

Returns (返回)

void

utils

utils: object;

utils: object;

utils.clearStorage

clearStorage: ClearStorageFn;

clearStorage: ClearStorageFn;

utils.getStorageSize

getStorageSize: GetStorageSizeFn;

getStorageSize: GetStorageSizeFn;

示例

// Basic localStorage collection
const collection = createCollection(
  localStorageCollectionOptions({
    storageKey: 'todos',
    getKey: (item) => item.id,
  })
)

// Basic localStorage collection
const collection = createCollection(
  localStorageCollectionOptions({
    storageKey: 'todos',
    getKey: (item) => item.id,
  })
)

// localStorage collection with custom storage
const collection = createCollection(
  localStorageCollectionOptions({
    storageKey: 'todos',
    storage: window.sessionStorage, // Use sessionStorage instead
    getKey: (item) => item.id,
  })
)

// localStorage collection with custom storage
const collection = createCollection(
  localStorageCollectionOptions({
    storageKey: 'todos',
    storage: window.sessionStorage, // Use sessionStorage instead
    getKey: (item) => item.id,
  })
)

// localStorage collection with mutation handlers
const collection = createCollection(
  localStorageCollectionOptions({
    storageKey: 'todos',
    getKey: (item) => item.id,
    onInsert: async ({ transaction }) => {
      console.log('Item inserted:', transaction.mutations[0].modified)
    },
  })
)

// localStorage collection with mutation handlers
const collection = createCollection(
  localStorageCollectionOptions({
    storageKey: 'todos',
    getKey: (item) => item.id,
    onInsert: async ({ transaction }) => {
      console.log('Item inserted:', transaction.mutations[0].modified)
    },
  })
)