Interface UseSimpleQueryProps<TQueryParams, TResult>

Type parameters

TQueryParams
TResult

Hierarchy

UseSimpleQueryProps

Index

Properties

Methods

Properties

Optional debounceDelay

debounceDelay?: number

queryParams

queryParams: TQueryParams

Methods

Optional onError

onError(e: unknown): void

- Defined in packages/iti-react-core/src/hooks/query/useSimpleQuery.ts:27
Parameters
- e: unknown
Returns void

Optional onLoadingChange

onLoadingChange(loading: boolean): void

- Defined in packages/iti-react-core/src/hooks/query/useSimpleQuery.ts:26
Parameters
- loading: boolean
Returns void

Optional onQueryStarted

onQueryStarted(): void

- Defined in packages/iti-react-core/src/hooks/query/useSimpleQuery.ts:30
Returns void

onResultReceived

onResultReceived(result: TResult): void

- Defined in packages/iti-react-core/src/hooks/query/useSimpleQuery.ts:25
Parameters
- result: TResult
Returns void

query

query(queryParams: TQueryParams): CancellablePromise<TResult>

- Defined in packages/iti-react-core/src/hooks/query/useSimpleQuery.ts:19
Parameters
- queryParams: TQueryParams
Returns CancellablePromise<TResult>

shouldQueryImmediately

shouldQueryImmediately(prevQueryParams: TQueryParams, queryParams: TQueryParams): boolean

- Defined in packages/iti-react-core/src/hooks/query/useSimpleQuery.ts:20
Parameters
- prevQueryParams: TQueryParams
- queryParams: TQueryParams
Returns boolean

Optional shouldSkipQuery

shouldSkipQuery(queryParams: TQueryParams): boolean

- Defined in packages/iti-react-core/src/hooks/query/useSimpleQuery.ts:33
Useful in uncommon scenarios to prevent unnecessary asynchronous updates to a component

Parameters
- queryParams: TQueryParams
Returns boolean

Generated using TypeDoc