📄 tanstack/db/latest/docs/reference/type-aliases/CollectionStatus

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


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

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

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")
}


// 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


// Status transitions
// idle → loading → ready (when markReady() is called)
// Any status can transition to → error or cleaned-up

Edit on GitHub

Home

Partners Become a Partner

scarf analytics