Skip to content
Source
Sign inSign up
TanStack/db
Open History to see the last commit

CollectionStatus.md

31 lines723 Bytes

Type Alias: CollectionStatus

type CollectionStatus = "idle" | "loading" | "ready" | "error" | "cleaned-up";

Defined in: packages/db/src/types.ts:507

Collection status values for lifecycle management

Examples

// Check collection status
if (collection.status === "loading") {
  console.log("Collection is loading initial data")
} else if (collection.status === "ready") {
  console.log("Collection is ready for use")
}
// Status transitions
// idle → loading → ready (when markReady() is called)
// Any status can transition to → error or cleaned-up