@finchart

Appearance

Documentation / @finchart/core / index / CursorHistoryLoader

Interface: CursorHistoryLoader<C> ​

Defined in: packages/core/src/extensions/infinite-history.ts:195

What infiniteHistory returns — a loader that also says where it stands, for a consumer that starts another one later from the same place (a chart remounted under a React key). C is the cursor mode's token type; an x-mode loader is a CursorHistoryLoader<never>.

Extends ​

Type Parameters ​

C ​

C

Properties ​

statusChanges ​

statusChanges: Observable<HistoryStatus>

Defined in: packages/core/src/extensions/infinite-history.ts:184

Notifies on every state change, with the state as it is at delivery — the pair a status bar or useSyncExternalStore needs. When a change is made from inside another listener, a listener can hear the same state twice in a row; it never hears a state that is no longer current.

Inherited from ​

HistoryLoader.statusChanges

Methods ​

cursor() ​

cursor(): C | null

Defined in: packages/core/src/extensions/infinite-history.ts:202

The token the next fetch would be asked with — moved by every page taken, an empty one included, which never reaches the sink. null once a page said there is none (done), and always in x mode, where the first x held is the place.

Returns ​

C | null

dispose() ​

dispose(): void

Defined in: packages/core/src/extensions/infinite-history.ts:186

Stops listening and reads "stopped" (unless already done or terminated); a response landing afterwards is dropped. Safe to call twice.

Returns ​

void

Inherited from ​

HistoryLoader.dispose

status() ​

status(): HistoryStatus

Defined in: packages/core/src/extensions/infinite-history.ts:177

Current state — a snapshot safe to read at any time.

Returns ​

HistoryStatus

Inherited from ​

HistoryLoader.status