UseLedgerUpdatesResult
Defined in: packages/react/src/hooks/useLedgerUpdates.ts:89
Properties
Section titled “Properties”clearHistory()
Section titled “clearHistory()”clearHistory: () =>
void
Defined in: packages/react/src/hooks/useLedgerUpdates.ts:111
Clear update history
Returns
Section titled “Returns”void
connectionStatus
Section titled “connectionStatus”connectionStatus:
"disconnected"|"connected"|"error"|"polling"
Defined in: packages/react/src/hooks/useLedgerUpdates.ts:105
Connection health status
currentOffset
Section titled “currentOffset”currentOffset:
string|undefined
Defined in: packages/react/src/hooks/useLedgerUpdates.ts:95
Current offset being tracked (string to preserve precision)
error:
Error|null
Defined in: packages/react/src/hooks/useLedgerUpdates.ts:103
Error if any
isError
Section titled “isError”isError:
boolean
Defined in: packages/react/src/hooks/useLedgerUpdates.ts:101
Whether there was an error
isLoading
Section titled “isLoading”isLoading:
boolean
Defined in: packages/react/src/hooks/useLedgerUpdates.ts:97
Whether initial load is in progress
isPolling
Section titled “isPolling”isPolling:
boolean
Defined in: packages/react/src/hooks/useLedgerUpdates.ts:99
Whether a poll is in progress
lastPollAge
Section titled “lastPollAge”lastPollAge:
number|undefined
Defined in: packages/react/src/hooks/useLedgerUpdates.ts:107
Time since last successful poll in ms
latestUpdate
Section titled “latestUpdate”latestUpdate:
TransactionUpdate|undefined
Defined in: packages/react/src/hooks/useLedgerUpdates.ts:93
Most recent update
poll()
Section titled “poll()”poll: () =>
void
Defined in: packages/react/src/hooks/useLedgerUpdates.ts:109
Manually trigger a poll
Returns
Section titled “Returns”void
updates
Section titled “updates”updates:
TransactionUpdate[]
Defined in: packages/react/src/hooks/useLedgerUpdates.ts:91
All updates received since hook mounted