Collection

Defined in: packages/db/src/collection/index.ts:148

Enhanced Collection interface that includes both data type T and utilities TUtils

Extends#

• CollectionImpl<T, TKey, TUtils, TSchema, TInsertInput>

Type Parameters#

T#

T extends object = Record<string, unknown>

The type of items in the collection

TKey#

TKey extends string | number = string | number

The type of the key for the collection

TUtils#

TUtils extends UtilsRecord = UtilsRecord

The utilities record type

TSchema#

TSchema extends StandardSchemaV1 = StandardSchemaV1

TInsertInput#

TInsertInput extends object = T

The type for insert operations (can be different from T for schemas with defaults)

Properties#

_lifecycle#

_lifecycle: CollectionLifecycleManager<T, TKey, TSchema, TInsertInput>;

Defined in: packages/db/src/collection/index.ts:411

Inherited from#

CollectionImpl._lifecycle

_state#

_state: CollectionStateManager<T, TKey, TSchema, TInsertInput>;

Defined in: packages/db/src/collection/index.ts:423

Inherited from#

CollectionImpl._state

_sync#

_sync: CollectionSyncManager<T, TKey, TSchema, TInsertInput>;

Defined in: packages/db/src/collection/index.ts:412

Inherited from#

CollectionImpl._sync

config#

config: CollectionConfig<T, TKey, TSchema, TUtils>;

Defined in: packages/db/src/collection/index.ts:402

Inherited from#

CollectionImpl.config

deferDataRefresh#

deferDataRefresh: Promise<void> | null = null;

Defined in: packages/db/src/collection/index.ts:430

When set, collection consumers should defer processing incoming data refreshes until this promise resolves. This prevents stale data from overwriting optimistic state while pending writes are being applied.

Inherited from#

CollectionImpl.deferDataRefresh

id#

id: string;

Defined in: packages/db/src/collection/index.ts:401

Inherited from#

CollectionImpl.id

singleResult?#

readonly optional singleResult: true;

Defined in: packages/db/src/collection/index.ts:156

utils#

readonly utils: TUtils;

Defined in: packages/db/src/collection/index.ts:155

Overrides#

CollectionImpl.utils

Accessors#

_layoutRevision#

Get Signature#

get _layoutRevision(): number;

Defined in: packages/db/src/collection/index.ts:578

Monotonic revision of explicit layout-only publications. Internal — used to distinguish them from empty ready events.

Returns#

number

Inherited from#

CollectionImpl._layoutRevision

_stateRevision#

Get Signature#

get _stateRevision(): number;

Defined in: packages/db/src/collection/index.ts:570

Monotonic revision of the collection's visible state; advances once per committed batch of changes and cleanup, even while nothing is subscribed. Internal — used by the live-query observer's snapshot cache.

Returns#

number

Inherited from#

CollectionImpl._stateRevision

base#

Get Signature#

get base(): CollectionBase<TKey, TOutput>;

Defined in: packages/db/src/collection/index.ts:718

The exposed authoritative base rows, before optimistic writes are applied. Queued sync writes are excluded. Reading does not start sync. Do not mutate the backing map or its rows: that bypasses publication.

Returns#

CollectionBase<TKey, TOutput>

Inherited from#

CollectionImpl.base

compareOptions#

Get Signature#

get compareOptions(): StringCollationConfig;

Defined in: packages/db/src/collection/index.ts:913

Returns#

StringCollationConfig

Inherited from#

CollectionImpl.compareOptions

indexes#

Get Signature#

get indexes(): Map<number, BaseIndex<TKey>>;

Defined in: packages/db/src/collection/index.ts:898

Get resolved indexes for query optimization

Returns#

Map<number, BaseIndex<TKey>>

Inherited from#

CollectionImpl.indexes

isLoadingSubset#

Get Signature#

get isLoadingSubset(): boolean;

Defined in: packages/db/src/collection/index.ts:636

Check if the collection is currently loading more data

Returns#

boolean

true if the collection has pending load more operations, false otherwise

Inherited from#

CollectionImpl.isLoadingSubset

size#

Get Signature#

get size(): number;

Defined in: packages/db/src/collection/index.ts:763

Get the current size of the collection (cached)

Returns#

number

Inherited from#

CollectionImpl.size

state#

Get Signature#

get state(): Map<TKey, WithVirtualProps<TOutput, TKey>>;

Defined in: packages/db/src/collection/index.ts:1090

Gets the current state of the collection as a Map

Example#

const itemsMap = collection.state
console.log(`Collection has ${itemsMap.size} items`)

for (const [key, item] of itemsMap) {
  console.log(`${key}: ${item.title}`)
}

// Check if specific item exists
if (itemsMap.has("todo-1")) {
  console.log("Todo 1 exists:", itemsMap.get("todo-1"))
}

Returns#

Map<TKey, WithVirtualProps<TOutput, TKey>>

Map containing all items in the collection, with keys as identifiers

Inherited from#

CollectionImpl.state

status#

Get Signature#

get status(): CollectionStatus;

Defined in: packages/db/src/collection/index.ts:553

Gets the current status of the collection

Returns#

CollectionStatus

Inherited from#

CollectionImpl.status

subscriberCount#

Get Signature#

get subscriberCount(): number;

Defined in: packages/db/src/collection/index.ts:561

Get the number of subscribers that ask for this collection's data. A live query that has no subscriber or preload of its own does not count.

Returns#

number

Inherited from#

CollectionImpl.subscriberCount

toArray#

Get Signature#

get toArray(): WithVirtualProps<TOutput, TKey>[];

Defined in: packages/db/src/collection/index.ts:1114

Gets the current state of the collection as an Array

Returns#

WithVirtualProps<TOutput, TKey>[]

An Array containing all items in the collection

Inherited from#

CollectionImpl.toArray

Methods#

_deferPublication()#

_deferPublication(): PublicationDeferral;

Defined in: packages/db/src/collection/index.ts:593

Defer subscriber events until a coherent multi-Collection commit ends.

Returns#

PublicationDeferral

Inherited from#

CollectionImpl._deferPublication

_deferSyncStart()#

_deferSyncStart(): boolean;

Defined in: packages/db/src/collection/index.ts:665

Internal

Returns#

boolean

Inherited from#

CollectionImpl._deferSyncStart

_hasHydratedKey()#

_hasHydratedKey(key): boolean;

Defined in: packages/db/src/collection/index.ts:660

Internal

Parameters#

key#

TKey

Returns#

boolean

Inherited from#

CollectionImpl._hasHydratedKey

_hasOptimisticOverlay()#

_hasOptimisticOverlay(key): boolean;

Defined in: packages/db/src/collection/index.ts:753

Whether a local write obscures this key's authoritative source row.

Parameters#

key#

TKey

Returns#

boolean

Inherited from#

CollectionImpl._hasOptimisticOverlay

_hasSubscriberOrPreload()#

_hasSubscriberOrPreload(): boolean;

Defined in: packages/db/src/collection/index.ts:704

Internal

Whether this Collection had a subscriber or a preload in this sync run.

Returns#

boolean

Inherited from#

CollectionImpl._hasSubscriberOrPreload

_markLayoutChange()#

_markLayoutChange(): void;

Defined in: packages/db/src/collection/index.ts:588

Mark the active sync transaction as layout-changing. Internal.

Returns#

void

Inherited from#

CollectionImpl._markLayoutChange

_markPreload()#

_markPreload(): void;

Defined in: packages/db/src/collection/index.ts:699

Internal

Record a preload without starting one, for a caller whose data request another promise answers, such as a DbClient stream for the same query. The request still counts: deferred acquisition may now resume.

Returns#

void

Inherited from#

CollectionImpl._markPreload

_onCleanupStart()#

_onCleanupStart(callback): () => void;

Defined in: packages/db/src/collection/index.ts:650

Internal

Subscribe to the synchronous cleanup-start boundary.

Parameters#

callback#

() => void

Returns#

(): void;

Returns#

void

Inherited from#

CollectionImpl._onCleanupStart

_onFirstSubscriberOrPreload()#

_onFirstSubscriberOrPreload(listener): () => void;

Defined in: packages/db/src/collection/index.ts:709

Internal

Listen for the first subscriber or preload in this sync run.

Parameters#

listener#

() => void

Returns#

(): void;

Returns#

void

Inherited from#

CollectionImpl._onFirstSubscriberOrPreload

_optimisticOverlaySize()#

_optimisticOverlaySize(): number;

Defined in: packages/db/src/collection/index.ts:746

Maximum number of source rows whose visible projection a local write can hide.

Returns#

number

Inherited from#

CollectionImpl._optimisticOverlaySize

_resumeSyncStart()#

_resumeSyncStart(): void;

Defined in: packages/db/src/collection/index.ts:670

Internal

Returns#

void

Inherited from#

CollectionImpl._resumeSyncStart

_setTransactionScope()#

_setTransactionScope(transactionScope): void;

Defined in: packages/db/src/collection/index.ts:655

Internal

Parameters#

transactionScope#

TransactionScope

Returns#

void

Inherited from#

CollectionImpl._setTransactionScope

_subscribeLayoutChanges()#

_subscribeLayoutChanges(listener): () => void;

Defined in: packages/db/src/collection/index.ts:583

Subscribe to layout-only publications. Internal observer channel.

Parameters#

listener#

() => void

Returns#

(): void;

Returns#

void

Inherited from#

CollectionImpl._subscribeLayoutChanges

_syncedRowMetadataKeysOutsideBase()#

_syncedRowMetadataKeysOutsideBase(): TKey[];

Defined in: packages/db/src/collection/index.ts:723

Internal

Applied metadata keys without a source row.

Returns#

TKey[]

Inherited from#

CollectionImpl._syncedRowMetadataKeysOutsideBase

[iterator]()#

iterator: IterableIterator<[TKey, WithVirtualProps<T, TKey>]>;

Defined in: packages/db/src/collection/index.ts:801

Get all entries (virtual derived state)

Returns#

IterableIterator<[TKey, WithVirtualProps<T, TKey>]>

Inherited from#

CollectionImpl.[iterator]

cleanup()#

cleanup(): Promise<void>;

Defined in: packages/db/src/collection/index.ts:1281

Clean up the collection by stopping sync and clearing data This can be called manually or automatically by garbage collection Cleanup callbacks must not restart this collection or call its preload(). Wait until cleanup completes before starting a new sync run. If adapter cleanup rejects, this promise rejects after the Collection reaches its final cleaned-up state.

Returns#

Promise<void>

Inherited from#

CollectionImpl.cleanup

createIndex()#

createIndex<TIndexType>(indexCallback, config): BaseIndex<TKey>;

Defined in: packages/db/src/collection/index.ts:867

Creates an index on a collection for faster queries. Indexes significantly improve query performance by allowing constant time lookups and logarithmic time range queries instead of full scans.

Type Parameters#

TIndexType#

TIndexType extends IndexConstructor<TKey>

Parameters#

indexCallback#

(row) => any

Function that extracts the indexed value from each item

config#

IndexOptions<TIndexType> = {}

Configuration including index type and type-specific options

Returns#

BaseIndex<TKey>

The created index

Example#

import { BasicIndex } from '@tanstack/db'

// Create an index with explicit type
const ageIndex = collection.createIndex((row) => row.age, {
  indexType: BasicIndex
})

// Create an index with collection's default type
const nameIndex = collection.createIndex((row) => row.name)

Inherited from#

CollectionImpl.createIndex

currentStateAsChanges()#

currentStateAsChanges(options): 
  | void
  | ChangeMessage<WithVirtualProps<T, TKey>, TKey>[];

Defined in: packages/db/src/collection/index.ts:1147

Returns the current state of the collection as an array of changes

Parameters#

options#

CurrentStateAsChangesOptions = {}

Options including optional where filter

Returns#

| void | ChangeMessage<WithVirtualProps<T, TKey>, TKey>[]

An array of changes

Example#

// Get all items as changes
const allChanges = collection.currentStateAsChanges()

// Get only items matching a condition
const activeChanges = collection.currentStateAsChanges({
  where: (row) => row.status === 'active'
})

// Get only items using a pre-compiled expression
const activeChanges = collection.currentStateAsChanges({
  whereExpression: eq(row.status, 'active')
})

Inherited from#

CollectionImpl.currentStateAsChanges

delete()#

delete(keys, config?): Transaction<any>;

Defined in: packages/db/src/collection/index.ts:1067

Deletes one or more items from the collection

Parameters#

keys#

Single key or array of keys to delete

TKey | TKey[]

config?#

OperationConfig

Optional configuration including metadata

Returns#

Transaction<any>

A Transaction object representing the delete operation(s)

Examples#

// Delete a single item
const tx = collection.delete("todo-1")
await tx.when('settled')

// Delete multiple items
const tx = collection.delete(["todo-1", "todo-2"])
await tx.when('settled')

// Delete with metadata
const tx = collection.delete("todo-1", { metadata: { reason: "completed" } })
await tx.when('settled')

// Handle errors
try {
  const tx = collection.delete("item-1")
  await tx.when('settled')
  console.log('Delete successful')
} catch (error) {
  console.log('Delete failed:', error)
}

Inherited from#

CollectionImpl.delete

entries()#

entries(): IterableIterator<[TKey, WithVirtualProps<T, TKey>]>;

Defined in: packages/db/src/collection/index.ts:789

Get all entries (virtual derived state)

Returns#

IterableIterator<[TKey, WithVirtualProps<T, TKey>]>

Inherited from#

CollectionImpl.entries

forEach()#

forEach(callbackfn): void;

Defined in: packages/db/src/collection/index.ts:810

Execute a callback for each entry in the collection

Parameters#

callbackfn#

(value, key, index) => void

Returns#

void

Inherited from#

CollectionImpl.forEach

get()#

get(key): 
  | WithVirtualProps<T, TKey>
  | undefined;

Defined in: packages/db/src/collection/index.ts:734

Get the current value for a key (virtual derived state)

Parameters#

key#

TKey

Returns#

| WithVirtualProps<T, TKey> | undefined

Inherited from#

CollectionImpl.get

getIndexMetadata()#

getIndexMetadata(): CollectionIndexMetadata[];

Defined in: packages/db/src/collection/index.ts:891

Returns a snapshot of current index metadata sorted by indexId. Persistence wrappers can use this to bootstrap index state if indexes were created before event listeners were attached.

Returns#

CollectionIndexMetadata[]

Inherited from#

CollectionImpl.getIndexMetadata

getKeyFromItem()#

getKeyFromItem(item): TKey;

Defined in: packages/db/src/collection/index.ts:841

Parameters#

item#

T

Returns#

TKey

Inherited from#

CollectionImpl.getKeyFromItem

has()#

has(key): boolean;

Defined in: packages/db/src/collection/index.ts:741

Check if a key exists in the collection (virtual derived state)

Parameters#

key#

TKey

Returns#

boolean

Inherited from#

CollectionImpl.has

insert()#

insert(data, config?): 
  | Transaction<Record<string, unknown>>
| Transaction<T>;

Defined in: packages/db/src/collection/index.ts:954

Inserts one or more items into the collection

Parameters#

data#

TInsertInput | TInsertInput[]

config?#

InsertConfig

Optional configuration including metadata

Returns#

| Transaction<Record<string, unknown>> | Transaction<T>

A Transaction object representing the insert operation(s)

Throws#

If the data fails schema validation

Examples#

// Insert a single todo (requires onInsert handler)
const tx = collection.insert({ id: "1", text: "Buy milk", completed: false })
await tx.when('settled')

// Insert multiple todos at once
const tx = collection.insert([
  { id: "1", text: "Buy milk", completed: false },
  { id: "2", text: "Walk dog", completed: true }
])
await tx.when('settled')

// Insert with metadata
const tx = collection.insert({ id: "1", text: "Buy groceries" },
  { metadata: { source: "mobile-app" } }
)
await tx.when('settled')

// Handle errors
try {
  const tx = collection.insert({ id: "1", text: "New item" })
  await tx.when('settled')
  console.log('Insert successful')
} catch (error) {
  console.log('Insert failed:', error)
}

Inherited from#

CollectionImpl.insert

isReady()#

isReady(): boolean;

Defined in: packages/db/src/collection/index.ts:628

Check if the collection is ready for use Returns true if the collection has been marked as ready by its sync implementation

Returns#

boolean

true if the collection is ready, false otherwise

Example#

if (collection.isReady()) {
  console.log('Collection is ready, data is available')
  // Safe to access collection.state
} else {
  console.log('Collection is still loading')
}

Inherited from#

CollectionImpl.isReady

keys()#

keys(): IterableIterator<TKey>;

Defined in: packages/db/src/collection/index.ts:770

Get all keys (virtual derived state)

Returns#

IterableIterator<TKey>

Inherited from#

CollectionImpl.keys

map()#

map<U>(callbackfn): U[];

Defined in: packages/db/src/collection/index.ts:826

Create a new array with the results of calling a function for each entry in the collection

Type Parameters#

U#

U

Parameters#

callbackfn#

(value, key, index) => U

Returns#

U[]

Inherited from#

CollectionImpl.map

off()#

off<T>(event, callback): void;

Defined in: packages/db/src/collection/index.ts:1256

Unsubscribe from a collection event

Type Parameters#

T#

T extends | "status:error" | "status:idle" | "status:loading" | "status:ready" | "status:cleaned-up" | "status:change" | "subscribers:change" | "loadingSubset:change" | "truncate" | "index:added" | "index:removed"

Parameters#

event#

T

callback#

CollectionEventHandler<T>

Returns#

void

Inherited from#

CollectionImpl.off

on()#

on<T>(event, callback): () => void;

Defined in: packages/db/src/collection/index.ts:1236

Subscribe to a collection event

Type Parameters#

T#

T extends | "status:error" | "status:idle" | "status:loading" | "status:ready" | "status:cleaned-up" | "status:change" | "subscribers:change" | "loadingSubset:change" | "truncate" | "index:added" | "index:removed"

Parameters#

event#

T

callback#

CollectionEventHandler<T>

Returns#

(): void;

Returns#

void

Inherited from#

CollectionImpl.on

once()#

once<T>(event, callback): () => void;

Defined in: packages/db/src/collection/index.ts:1246

Subscribe to a collection event once

Type Parameters#

T#

T extends | "status:error" | "status:idle" | "status:loading" | "status:ready" | "status:cleaned-up" | "status:change" | "subscribers:change" | "loadingSubset:change" | "truncate" | "index:added" | "index:removed"

Parameters#

event#

T

callback#

CollectionEventHandler<T>

Returns#

(): void;

Returns#

void

Inherited from#

CollectionImpl.once

onFirstReady()#

onFirstReady(callback): () => void;

Defined in: packages/db/src/collection/index.ts:612

Register a callback to be executed when the collection first becomes ready Useful for preloading collections Every callback queued before the transition runs. Because ready state is established first, callbacks registered during or after delivery run immediately. If one throws, the collection remains ready. Direct sync startup rethrows the first failure; preload resolves from ready state. Cleanup discards pending callbacks without invoking them.

Parameters#

callback#

() => void

Function to call when the collection first becomes ready

Returns#

(): void;

Returns#

void

Example#

collection.onFirstReady(() => {
  console.log('Collection is ready for the first time')
  // Safe to access collection.state now
})

Inherited from#

CollectionImpl.onFirstReady

preload()#

preload(): Promise<void>;

Defined in: packages/db/src/collection/index.ts:678

Preload the collection data by starting sync if not already started Multiple concurrent calls will share the same promise

Returns#

Promise<void>

Inherited from#

CollectionImpl.preload

removeIndex()#

removeIndex(indexOrId): boolean;

Defined in: packages/db/src/collection/index.ts:882

Removes an index created with createIndex. Returns true when an index existed and was removed.

Best-effort semantics: removing an index guarantees it is detached from collection query planning. Existing index proxy references should be treated as invalid after removal.

Parameters#

indexOrId#

number | BaseIndex<TKey>

Returns#

boolean

Inherited from#

CollectionImpl.removeIndex

startSyncImmediate()#

startSyncImmediate(): void;

Defined in: packages/db/src/collection/index.ts:645

Start sync immediately - internal method for compiled queries This bypasses lazy loading for special cases like live query results Throws during active cleanup; restart after cleanup completes instead.

Returns#

void

Inherited from#

CollectionImpl.startSyncImmediate

stateWhenReady()#

stateWhenReady(): Promise<Map<TKey, WithVirtualProps<T, TKey>>>;

Defined in: packages/db/src/collection/index.ts:1105

Gets the current state of the collection as a Map once the collection is ready Resolves when preload() does. For a live query, that is initial-query readiness, so visible rows alone do not resolve it.

Returns#

Promise<Map<TKey, WithVirtualProps<T, TKey>>>

Promise that resolves to a Map containing all items in the collection

Inherited from#

CollectionImpl.stateWhenReady

subscribeChanges()#

Call Signature#

subscribeChanges(callback, options?): CollectionSubscription;

Defined in: packages/db/src/collection/index.ts:1199

Subscribe to changes in the collection Changes to the same key retain their causal order within a callback. Changes to different keys have no promised order within a callback.

Parameters#

callback#

(changes) => void

Function called when items change

options?#

SubscribeChangesOptions<T, TKey>

Subscription options including includeInitialState and where filter

Returns#

CollectionSubscription

Unsubscribe function - Call this to stop listening for changes

Examples#

// Basic subscription
const subscription = collection.subscribeChanges((changes) => {
  changes.forEach(change => {
    console.log(`${change.type}: ${change.key}`, change.value)
  })
})

// Later: subscription.unsubscribe()

// Include current state immediately
const subscription = collection.subscribeChanges((changes) => {
  updateUI(changes)
}, { includeInitialState: true })

// Subscribe only to changes matching a condition using where callback
import { eq } from "@tanstack/db"

const subscription = collection.subscribeChanges((changes) => {
  updateUI(changes)
}, {
  includeInitialState: true,
  where: (row) => eq(row.status, "active")
})

// Using multiple conditions with and()
import { and, eq, gt } from "@tanstack/db"

const subscription = collection.subscribeChanges((changes) => {
  updateUI(changes)
}, {
  where: (row) => and(eq(row.status, "active"), gt(row.priority, 5))
})

Inherited from#

CollectionImpl.subscribeChanges

Call Signature#

subscribeChanges(callback, options?): CollectionSubscription;

Defined in: packages/db/src/collection/index.ts:1207

Subscribe to changes in the collection Changes to the same key retain their causal order within a callback. Changes to different keys have no promised order within a callback.

Parameters#

callback#

Function called when items change

(changes) => void | (changes) => void

options?#

SubscribeChangesOptions<T, TKey>

Subscription options including includeInitialState and where filter

Returns#

CollectionSubscription

Unsubscribe function - Call this to stop listening for changes

Examples#

// Basic subscription
const subscription = collection.subscribeChanges((changes) => {
  changes.forEach(change => {
    console.log(`${change.type}: ${change.key}`, change.value)
  })
})

// Later: subscription.unsubscribe()

// Include current state immediately
const subscription = collection.subscribeChanges((changes) => {
  updateUI(changes)
}, { includeInitialState: true })

// Subscribe only to changes matching a condition using where callback
import { eq } from "@tanstack/db"

const subscription = collection.subscribeChanges((changes) => {
  updateUI(changes)
}, {
  includeInitialState: true,
  where: (row) => eq(row.status, "active")
})

// Using multiple conditions with and()
import { and, eq, gt } from "@tanstack/db"

const subscription = collection.subscribeChanges((changes) => {
  updateUI(changes)
}, {
  where: (row) => and(eq(row.status, "active"), gt(row.priority, 5))
})

Inherited from#

CollectionImpl.subscribeChanges

toArrayWhenReady()#

toArrayWhenReady(): Promise<WithVirtualProps<T, TKey>[]>;

Defined in: packages/db/src/collection/index.ts:1125

Gets the current state of the collection as an Array once the collection is ready Resolves when preload() does. For a live query, that is initial-query readiness, so visible rows alone do not resolve it.

Returns#

Promise<WithVirtualProps<T, TKey>[]>

Promise that resolves to an Array containing all items in the collection

Inherited from#

CollectionImpl.toArrayWhenReady

update()#

Call Signature#

update(key, callback): Transaction;

Defined in: packages/db/src/collection/index.ts:999

Updates one or more items in the collection using a callback function

Parameters#

key#

TKey[]

callback#

(drafts) => void

Returns#

Transaction

A Transaction object representing the update operation(s)

Throws#

If the updated data fails schema validation

Examples#

// Update single item by key
const tx = collection.update("todo-1", (draft) => {
  draft.completed = true
})
await tx.when('settled')

// Update multiple items
const tx = collection.update(["todo-1", "todo-2"], (drafts) => {
  drafts.forEach(draft => { draft.completed = true })
})
await tx.when('settled')

// Update with metadata
const tx = collection.update("todo-1",
  { metadata: { reason: "user update" } },
  (draft) => { draft.text = "Updated text" }
)
await tx.when('settled')

// Handle errors
try {
  const tx = collection.update("item-1", draft => { draft.value = "new" })
  await tx.when('settled')
  console.log('Update successful')
} catch (error) {
  console.log('Update failed:', error)
}

Inherited from#

CollectionImpl.update

Call Signature#

update(
   keys, 
   config, 
   callback): Transaction;

Defined in: packages/db/src/collection/index.ts:1005

Updates one or more items in the collection using a callback function

Parameters#

keys#

TKey[]

Single key or array of keys to update

config#

OperationConfig

callback#

(drafts) => void

Returns#

Transaction

A Transaction object representing the update operation(s)

Throws#

If the updated data fails schema validation

Examples#

// Update single item by key
const tx = collection.update("todo-1", (draft) => {
  draft.completed = true
})
await tx.when('settled')

// Update multiple items
const tx = collection.update(["todo-1", "todo-2"], (drafts) => {
  drafts.forEach(draft => { draft.completed = true })
})
await tx.when('settled')

// Update with metadata
const tx = collection.update("todo-1",
  { metadata: { reason: "user update" } },
  (draft) => { draft.text = "Updated text" }
)
await tx.when('settled')

// Handle errors
try {
  const tx = collection.update("item-1", draft => { draft.value = "new" })
  await tx.when('settled')
  console.log('Update successful')
} catch (error) {
  console.log('Update failed:', error)
}

Inherited from#

CollectionImpl.update

Call Signature#

update(id, callback): Transaction;

Defined in: packages/db/src/collection/index.ts:1012

Updates one or more items in the collection using a callback function

Parameters#

id#

TKey

callback#

(draft) => void

Returns#

Transaction

A Transaction object representing the update operation(s)

Throws#

If the updated data fails schema validation

Examples#

// Update single item by key
const tx = collection.update("todo-1", (draft) => {
  draft.completed = true
})
await tx.when('settled')

// Update multiple items
const tx = collection.update(["todo-1", "todo-2"], (drafts) => {
  drafts.forEach(draft => { draft.completed = true })
})
await tx.when('settled')

// Update with metadata
const tx = collection.update("todo-1",
  { metadata: { reason: "user update" } },
  (draft) => { draft.text = "Updated text" }
)
await tx.when('settled')

// Handle errors
try {
  const tx = collection.update("item-1", draft => { draft.value = "new" })
  await tx.when('settled')
  console.log('Update successful')
} catch (error) {
  console.log('Update failed:', error)
}

Inherited from#

CollectionImpl.update

Call Signature#

update(
   id, 
   config, 
   callback): Transaction;

Defined in: packages/db/src/collection/index.ts:1018

Updates one or more items in the collection using a callback function

Parameters#

id#

TKey

config#

OperationConfig

callback#

(draft) => void

Returns#

Transaction

A Transaction object representing the update operation(s)

Throws#

If the updated data fails schema validation

Examples#

// Update single item by key
const tx = collection.update("todo-1", (draft) => {
  draft.completed = true
})
await tx.when('settled')

// Update multiple items
const tx = collection.update(["todo-1", "todo-2"], (drafts) => {
  drafts.forEach(draft => { draft.completed = true })
})
await tx.when('settled')

// Update with metadata
const tx = collection.update("todo-1",
  { metadata: { reason: "user update" } },
  (draft) => { draft.text = "Updated text" }
)
await tx.when('settled')

// Handle errors
try {
  const tx = collection.update("item-1", draft => { draft.value = "new" })
  await tx.when('settled')
  console.log('Update successful')
} catch (error) {
  console.log('Update failed:', error)
}

Inherited from#

CollectionImpl.update

validateData()#

validateData(
   data, 
   type, 
   key?): T;

Defined in: packages/db/src/collection/index.ts:905

Validates the data against the schema

Parameters#

data#

unknown

type#

"insert" | "update"

key?#

TKey

Returns#

T

Inherited from#

CollectionImpl.validateData

values()#

values(): IterableIterator<WithVirtualProps<T, TKey>>;

Defined in: packages/db/src/collection/index.ts:777

Get all values (virtual derived state)

Returns#

IterableIterator<WithVirtualProps<T, TKey>>

Inherited from#

CollectionImpl.values

waitFor()#

waitFor<T>(event, timeout?): Promise<AllCollectionEvents[T]>;

Defined in: packages/db/src/collection/index.ts:1266

Wait for a collection event

Type Parameters#

T#

T extends | "status:error" | "status:idle" | "status:loading" | "status:ready" | "status:cleaned-up" | "status:change" | "subscribers:change" | "loadingSubset:change" | "truncate" | "index:added" | "index:removed"

Parameters#

event#

T

timeout?#

number

Returns#

Promise<AllCollectionEvents[T]>

Inherited from#

CollectionImpl.waitFor