UseRecordsResult

@justaname.id/react • Docs

---

@justaname.id/react / UseRecordsResult

Interface: UseRecordsResult

Properties

getRecords()

getRecords: (params, forceUpdate?) => Promise<Records>

Parameters

• params: GetRecordsParams

• forceUpdate?: boolean

Returns

Promise<Records>

Defined in

packages/@justaname.id/react/src/lib/hooks/records/useRecords.ts:42

---

isRecordsFetching

isRecordsFetching: boolean

Defined in

packages/@justaname.id/react/src/lib/hooks/records/useRecords.ts:39

---

isRecordsLoading

isRecordsLoading: boolean

Defined in

packages/@justaname.id/react/src/lib/hooks/records/useRecords.ts:40

---

isRecordsPending

isRecordsPending: boolean

Defined in

packages/@justaname.id/react/src/lib/hooks/records/useRecords.ts:38

---

records

records: undefined | Records

Defined in

packages/@justaname.id/react/src/lib/hooks/records/useRecords.ts:41

---

recordsStatus

recordsStatus: "error" | "success" | "pending"

Defined in

packages/@justaname.id/react/src/lib/hooks/records/useRecords.ts:49

---

refetchRecords()

refetchRecords: (options?) => Promise<QueryObserverResult<undefined | Records, unknown>>

Parameters

• options?: RefetchOptions

Returns

Promise<QueryObserverResult<undefined | Records, unknown>>

Defined in

packages/@justaname.id/react/src/lib/hooks/records/useRecords.ts:46