Skip to main content
Module

x/earthstar/mod.browser.ts>SyncAgentStatus

Earthstar is a tool for private, undiscoverable, offline-first networks.
earthstar-project/earthstar
Go to Latest
type alias SyncAgentStatus
import { type SyncAgentStatus } from "https://deno.land/x/earthstar@v10.0.0-alpha.3/mod.browser.ts";

The current status of a SyncAgent

  • requested: The number of documents requested
  • received: The number of requests responded to
  • status: An overall status of the agent. preparing is when it is calculating its HAVE entries, syncing when it has unfulfilled requests, idling when there are no active requests, and done when it has been closed, or received all documents it was interested in.
definition: { requested: number; received: number; status:
| "preparing"
| "syncing"
| "idling"
| "done"
| "aborted"
; }