# UseRecordsResult

[**@justaname.id/react**](https://docs.justaname.id/sdk-reference/justaname-react-sdk) • **Docs**

***

[@justaname.id/react](https://docs.justaname.id/sdk-reference/justaname-react-sdk/globals) / UseRecordsResult

## Interface: UseRecordsResult

### Properties

#### getRecords()

> **getRecords**: (`params`, `forceUpdate`?) => `Promise`<[`Records`](https://docs.justaname.id/sdk-reference/justaname-react-sdk/interfaces/records)>

**Parameters**

• **params**: [`GetRecordsParams`](https://docs.justaname.id/sdk-reference/justaname-react-sdk/interfaces/getrecordsparams)

• **forceUpdate?**: `boolean`

**Returns**

`Promise`<[`Records`](https://docs.justaname.id/sdk-reference/justaname-react-sdk/interfaces/records)>

**Defined in**

[packages/@justaname.id/react/src/lib/hooks/records/useRecords.ts:42](https://github.com/JustaName-id/JustaName-sdk/blob/dc845c10af242e3ca87d95ef392516ac0bfa8b95/packages/@justaname.id/react/src/lib/hooks/records/useRecords.ts#L42)

***

#### isRecordsFetching

> **isRecordsFetching**: `boolean`

**Defined in**

[packages/@justaname.id/react/src/lib/hooks/records/useRecords.ts:39](https://github.com/JustaName-id/JustaName-sdk/blob/dc845c10af242e3ca87d95ef392516ac0bfa8b95/packages/@justaname.id/react/src/lib/hooks/records/useRecords.ts#L39)

***

#### isRecordsLoading

> **isRecordsLoading**: `boolean`

**Defined in**

[packages/@justaname.id/react/src/lib/hooks/records/useRecords.ts:40](https://github.com/JustaName-id/JustaName-sdk/blob/dc845c10af242e3ca87d95ef392516ac0bfa8b95/packages/@justaname.id/react/src/lib/hooks/records/useRecords.ts#L40)

***

#### isRecordsPending

> **isRecordsPending**: `boolean`

**Defined in**

[packages/@justaname.id/react/src/lib/hooks/records/useRecords.ts:38](https://github.com/JustaName-id/JustaName-sdk/blob/dc845c10af242e3ca87d95ef392516ac0bfa8b95/packages/@justaname.id/react/src/lib/hooks/records/useRecords.ts#L38)

***

#### records

> **records**: `undefined` | [`Records`](https://docs.justaname.id/sdk-reference/justaname-react-sdk/interfaces/records)

**Defined in**

[packages/@justaname.id/react/src/lib/hooks/records/useRecords.ts:41](https://github.com/JustaName-id/JustaName-sdk/blob/dc845c10af242e3ca87d95ef392516ac0bfa8b95/packages/@justaname.id/react/src/lib/hooks/records/useRecords.ts#L41)

***

#### recordsStatus

> **recordsStatus**: `"error"` | `"success"` | `"pending"`

**Defined in**

[packages/@justaname.id/react/src/lib/hooks/records/useRecords.ts:49](https://github.com/JustaName-id/JustaName-sdk/blob/dc845c10af242e3ca87d95ef392516ac0bfa8b95/packages/@justaname.id/react/src/lib/hooks/records/useRecords.ts#L49)

***

#### refetchRecords()

> **refetchRecords**: (`options`?) => `Promise`<`QueryObserverResult`<`undefined` | [`Records`](https://docs.justaname.id/sdk-reference/justaname-react-sdk/interfaces/records), `unknown`>>

**Parameters**

• **options?**: `RefetchOptions`

**Returns**

`Promise`<`QueryObserverResult`<`undefined` | [`Records`](https://docs.justaname.id/sdk-reference/justaname-react-sdk/interfaces/records), `unknown`>>

**Defined in**

[packages/@justaname.id/react/src/lib/hooks/records/useRecords.ts:46](https://github.com/JustaName-id/JustaName-sdk/blob/dc845c10af242e3ca87d95ef392516ac0bfa8b95/packages/@justaname.id/react/src/lib/hooks/records/useRecords.ts#L46)