Interface: CollectionConfig<T, TKey, TSchema, TInsertInput>

Definiert in: packages/db/src/types.ts:349

Typparameter

• T extends object = Record<string, unknown>

• TKey erweitert string | number = string | number

• TSchema extends StandardSchemaV1 = StandardSchemaV1

• TInsertInput extends object = T

Eigenschaften

autoIndex?

optional autoIndex: "off" | "eager";

optional autoIndex: "off" | "eager";

Definiert in: packages/db/src/types.ts:388

Auto-Indexing-Modus für die Collection. Wenn aktiviert, werden Indizes automatisch für einfache Where-Ausdrücke erstellt.

Standard

"eager"

"eager"

Beschreibung

"off": Kein automatisches Indexing
"eager": Erstellt automatisch Indizes für einfache Where-Ausdrücke in subscribeChanges (Standard)

compare()?

optional compare: (x, y) => number;

optional compare: (x, y) => number;

Definiert in: packages/db/src/types.ts:399

Optionale Funktion zum Vergleichen zweier Elemente. Diese wird verwendet, um die Elemente in der Collection zu sortieren.

Parameter

x

Das erste zu vergleichende Element

y

Das zweite zu vergleichende Element

Gibt zurück

number

Eine Zahl, die die Reihenfolge der Elemente angibt

Beispiel

// For a collection with a 'createdAt' field
compare: (x, y) => x.createdAt.getTime() - y.createdAt.getTime()

// For a collection with a 'createdAt' field
compare: (x, y) => x.createdAt.getTime() - y.createdAt.getTime()

gcTime?

optional gcTime: number;

optional gcTime: number;

Definiert in: packages/db/src/types.ts:374

Zeit in Millisekunden, nach der die Collection gesammelt wird, wenn sie keine aktiven Abonnenten hat. Standardmäßig 5 Minuten (300000ms).

getKey()

getKey: (item) => TKey;

getKey: (item) => TKey;

Definiert in: packages/db/src/types.ts:369

Funktion zum Extrahieren der ID aus einem Objekt. Dies ist erforderlich für Update/Delete-Operationen, die jetzt nur noch IDs akzeptieren.

// For a collection with a 'uuid' field as the primary key
getKey: (item) => item.uuid

// For a collection with a 'uuid' field as the primary key
getKey: (item) => item.uuid

id?

optional id: string;

optional id: string;

Definiert in: packages/db/src/types.ts:357

onDelete?

optional onDelete: DeleteMutationFn<T, TKey, Record<string, Fn>>;

optional onDelete: DeleteMutationFn<T, TKey, Record<string, Fn>>;

Definiert in: packages/db/src/types.ts:528

Optionale asynchrone Handler-Funktion, die vor einer Delete-Operation aufgerufen wird.

// Basic delete handler
onDelete: async ({ transaction, collection }) => {
  const deletedKey = transaction.mutations[0].key
  await api.deleteTodo(deletedKey)
}

// Basic delete handler
onDelete: async ({ transaction, collection }) => {
  const deletedKey = transaction.mutations[0].key
  await api.deleteTodo(deletedKey)
}

// Delete handler with multiple items
onDelete: async ({ transaction, collection }) => {
  const keysToDelete = transaction.mutations.map(m => m.key)
  await api.deleteTodos(keysToDelete)
}

// Delete handler with multiple items
onDelete: async ({ transaction, collection }) => {
  const keysToDelete = transaction.mutations.map(m => m.key)
  await api.deleteTodos(keysToDelete)
}

// Delete handler with confirmation
onDelete: async ({ transaction, collection }) => {
  const mutation = transaction.mutations[0]
  const shouldDelete = await confirmDeletion(mutation.original)
  if (!shouldDelete) {
    throw new Error('Delete cancelled by user')
  }
  await api.deleteTodo(mutation.original.id)
}

// Delete handler with confirmation
onDelete: async ({ transaction, collection }) => {
  const mutation = transaction.mutations[0]
  const shouldDelete = await confirmDeletion(mutation.original)
  if (!shouldDelete) {
    throw new Error('Delete cancelled by user')
  }
  await api.deleteTodo(mutation.original.id)
}

// Delete handler with optimistic rollback
onDelete: async ({ transaction, collection }) => {
  const mutation = transaction.mutations[0]
  try {
    await api.deleteTodo(mutation.original.id)
  } catch (error) {
    // Transaction will automatically rollback optimistic changes
    console.error('Delete failed, rolling back:', error)
    throw error
  }
}

// Delete handler with optimistic rollback
onDelete: async ({ transaction, collection }) => {
  const mutation = transaction.mutations[0]
  try {
    await api.deleteTodo(mutation.original.id)
  } catch (error) {
    // Transaction will automatically rollback optimistic changes
    console.error('Delete failed, rolling back:', error)
    throw error
  }
}

onInsert?

optional onInsert: InsertMutationFn<TInsertInput, TKey, Record<string, Fn>>;

optional onInsert: InsertMutationFn<TInsertInput, TKey, Record<string, Fn>>;

Definiert in: packages/db/src/types.ts:441

Optionale asynchrone Handler-Funktion, die vor einer Insert-Operation aufgerufen wird.

// Basic insert handler
onInsert: async ({ transaction, collection }) => {
  const newItem = transaction.mutations[0].modified
  await api.createTodo(newItem)
}

// Basic insert handler
onInsert: async ({ transaction, collection }) => {
  const newItem = transaction.mutations[0].modified
  await api.createTodo(newItem)
}

// Insert handler with multiple items
onInsert: async ({ transaction, collection }) => {
  const items = transaction.mutations.map(m => m.modified)
  await api.createTodos(items)
}

// Insert handler with multiple items
onInsert: async ({ transaction, collection }) => {
  const items = transaction.mutations.map(m => m.modified)
  await api.createTodos(items)
}

// Insert handler with error handling
onInsert: async ({ transaction, collection }) => {
  try {
    const newItem = transaction.mutations[0].modified
    const result = await api.createTodo(newItem)
    return result
  } catch (error) {
    console.error('Insert failed:', error)
    throw error // This will cause the transaction to fail
  }
}

// Insert handler with error handling
onInsert: async ({ transaction, collection }) => {
  try {
    const newItem = transaction.mutations[0].modified
    const result = await api.createTodo(newItem)
    return result
  } catch (error) {
    console.error('Insert failed:', error)
    throw error // This will cause the transaction to fail
  }
}

// Insert handler with metadata
onInsert: async ({ transaction, collection }) => {
  const mutation = transaction.mutations[0]
  await api.createTodo(mutation.modified, {
    source: mutation.metadata?.source,
    timestamp: mutation.createdAt
  })
}

// Insert handler with metadata
onInsert: async ({ transaction, collection }) => {
  const mutation = transaction.mutations[0]
  await api.createTodo(mutation.modified, {
    source: mutation.metadata?.source,
    timestamp: mutation.createdAt
  })
}

onUpdate?

optional onUpdate: UpdateMutationFn<T, TKey, Record<string, Fn>>;

optional onUpdate: UpdateMutationFn<T, TKey, Record<string, Fn>>;

Definiert in: packages/db/src/types.ts:485

Optionale asynchrone Handler-Funktion, die vor einer Update-Operation aufgerufen wird.

// Basic update handler
onUpdate: async ({ transaction, collection }) => {
  const updatedItem = transaction.mutations[0].modified
  await api.updateTodo(updatedItem.id, updatedItem)
}

// Basic update handler
onUpdate: async ({ transaction, collection }) => {
  const updatedItem = transaction.mutations[0].modified
  await api.updateTodo(updatedItem.id, updatedItem)
}

// Update handler with partial updates
onUpdate: async ({ transaction, collection }) => {
  const mutation = transaction.mutations[0]
  const changes = mutation.changes // Only the changed fields
  await api.updateTodo(mutation.original.id, changes)
}

// Update handler with partial updates
onUpdate: async ({ transaction, collection }) => {
  const mutation = transaction.mutations[0]
  const changes = mutation.changes // Only the changed fields
  await api.updateTodo(mutation.original.id, changes)
}

// Update handler with multiple items
onUpdate: async ({ transaction, collection }) => {
  const updates = transaction.mutations.map(m => ({
    id: m.key,
    changes: m.changes
  }))
  await api.updateTodos(updates)
}

// Update handler with multiple items
onUpdate: async ({ transaction, collection }) => {
  const updates = transaction.mutations.map(m => ({
    id: m.key,
    changes: m.changes
  }))
  await api.updateTodos(updates)
}

// Update handler with optimistic rollback
onUpdate: async ({ transaction, collection }) => {
  const mutation = transaction.mutations[0]
  try {
    await api.updateTodo(mutation.original.id, mutation.changes)
  } catch (error) {
    // Transaction will automatically rollback optimistic changes
    console.error('Update failed, rolling back:', error)
    throw error
  }
}

// Update handler with optimistic rollback
onUpdate: async ({ transaction, collection }) => {
  const mutation = transaction.mutations[0]
  try {
    await api.updateTodo(mutation.original.id, mutation.changes)
  } catch (error) {
    // Transaction will automatically rollback optimistic changes
    console.error('Update failed, rolling back:', error)
    throw error
  }
}

schema?

optional schema: TSchema;

optional schema: TSchema;

Definiert in: packages/db/src/types.ts:359

startSync?

optional startSync: boolean;

optional startSync: boolean;

Definiert in: packages/db/src/types.ts:379

Gibt an, ob sofort mit der Synchronisierung begonnen werden soll, wenn die Collection erstellt wird. Standardmäßig false für Lazy Loading. Auf true setzen, um sofort zu synchronisieren.