Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • TRecord

Hierarchy

  • UseRecordsResult

Index

Properties

Optional client

client: Client

Client used to connect (see the non-react beneath library)

Optional error

error: Error

Error returned by the query

Optional fetchMore

Callback to trigger fetching another page

Optional fetchMoreChanges

fetchMoreChanges: FetchMoreFunction

Callback to trigger fetching changes (not applicable if subscribed to websockets)

loading

loading: boolean

True if currently loading for the first time (not if subscribed to websockets)

records

records: Record<TRecord>[]

Records returned by query. If subscribed to websockets, may change on re-renders

subscription

subscription: { error?: Error; online: boolean }

Status on the websockets subscription

Type declaration

  • Optional error?: Error

    Error returned from the websocket connection

  • online: boolean

    True if a websocket connection is open

truncation

truncation: { end: boolean; start: boolean }

Status on whether records have been truncated under the truncation policy

Type declaration

  • end: boolean

    True if records were truncated from the start

  • start: boolean

    True if records were truncated from the start

Legend

  • Property

Generated using TypeDoc