Funktion: localStorageCollectionOptions()

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

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

Definiert in: packages/db/src/local-storage.ts:205

Erstellt localStorage-Sammlungsoptionen zur Verwendung mit einer Standard-Collection

Diese Funktion erstellt eine Collection, die Daten in localStorage/sessionStorage speichert und Änderungen über Browser-Tabs hinweg mithilfe von Storage-Events synchronisiert.

Typparameter

• TExplicit = unknown

Der explizite Typ der Elemente in der Collection (höchste Priorität)

• TSchema erweitert StandardSchemaV1<unknown, unknown> = never

Der Schema-Typ für Validierung und Typableitung (zweite Priorität)

• TFallback erweitert object = Record<string, unknown>

Der Fallback-Typ, wenn kein expliziter Typ oder kein Schema-Typ angegeben wird

Parameter

config

LocalStorageCollectionConfig<TExplicit, TSchema, TFallback>

Konfigurationsoptionen für die localStorage-Collection

Gibt zurück

Objekt

Collection-Optionen mit Utilities, einschließlich clearStorage und getStorageSize

getKey()

getKey: (item) => string | number;

getKey: (item) => string | number;

Parameter

item

ResolveType

Gibt zurück

string | number

id

id: string = collectionId;

id: string = collectionId;

onDelete()

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

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

Parameter

params

DeleteMutationFnParams<ResolveType<TExplicit, TSchema, TFallback>>

Gibt zurück

Promise<any>

onInsert()

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

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

Parameter

params

InsertMutationFnParams<ResolveType<TExplicit, TSchema, TFallback>>

Gibt zurück

Promise<any>

onUpdate()

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

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

Parameter

params

UpdateMutationFnParams<ResolveType<TExplicit, TSchema, TFallback>>

Gibt zurück

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;

Typdeklaration

manualTrigger()?

optional manualTrigger: () => void;

optional manualTrigger: () => void;

Gibt zurück

void

utils

utils: object;

utils: object;

utils.clearStorage

clearStorage: ClearStorageFn;

clearStorage: ClearStorageFn;

utils.getStorageSize

getStorageSize: GetStorageSizeFn;

getStorageSize: GetStorageSizeFn;

Beispiele

// 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)
    },
  })
)