Interface DocumentProgress<T>

ReadonlydocumentId

error

• get error(): undefined | Error

  Returns undefined | Error

  Deprecated

  read via peek() — error is only set on the failed state. Will be removed in the next major release.

progress

• get progress(): undefined | number

  Returns undefined | number

  Deprecated

  Will be removed in the next major release.

state

• get state(): "loading" | "ready" | "unavailable" | "failed"

  Returns "loading" | "ready" | "unavailable" | "failed"

  Deprecated

  read via peek().state. Will be removed in the next major release.

peek

• peek(): QueryState<T>

  Returns the current state of the query.

  Returns QueryState<T>

subscribe

• subscribe(callback: (state: QueryState<T>) => void): () => void

  Subscribe to state changes. The callback fires whenever the query transitions to a new state. Returns an unsubscribe function.

  Parameters

  • callback: (state: QueryState<T>) => void

  Returns () => void

whenReady

• whenReady(options?: { signal?: AbortSignal }): Promise<DocHandle<T>>

  Returns a promise that resolves with the DocHandle when the query reaches the ready state. Rejects if the query fails or the signal is aborted.

  Parameters

  • Optionaloptions: { signal?: AbortSignal }

  Returns Promise<DocHandle<T>>