Interface NewsSnapshot

interface NewsSnapshot {
    error: null | string;
    hasMore: boolean;
    instrument: null | InstrumentKey;
    items: readonly NewsItem[];
    loadedAt: null | number;
    loadingMore: boolean;
    refreshFailed: boolean;
    stale: boolean;
    status: NewsStatus;
}

Properties

error: null | string

The latest failure, cleared by the next success.

hasMore: boolean

The provider offered an older page.

instrument: null | InstrumentKey

items: readonly NewsItem[]

Newest first, one per provider ID.

loadedAt: null | number

Local clock in milliseconds of the last newest-page answer.

loadingMore: boolean

refreshFailed: boolean

The newest page failed to reload and the items shown are the earlier answer.

stale: boolean

The items shown could not be refreshed, or have outlived the stale window.

loading covers a refresh too; the items already shown stay in items.