# InfiniteQueryConfig

Defined in: [react/src/createInfiniteQuery.ts:105](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/createInfiniteQuery.ts#L105)

Configuration for createActorInfiniteQuery.
Extends InfiniteQueryObserverOptions to accept standard TanStack Query
infinite-query options at the create level (e.g. refetchInterval,
refetchOnMount, refetchOnWindowFocus, retry, gcTime, networkMode).

## Extends

- `Omit`\<`InfiniteQueryObserverOptions`\<[`InfiniteQueryPageData`](https://ic-reactor.b3pay.net/v3/libs/type-aliases/infinitequerypagedata/)\<`Service`, `Method`, `Transform`\>, [`InfiniteQueryError`](https://ic-reactor.b3pay.net/v3/libs/type-aliases/infinitequeryerror/)\<`Service`, `Method`, `Transform`\>, `Selected`, `QueryKey`, `TPageParam`\>, `"queryKey"` \| `"queryFn"`\>

## Type Parameters

### Service

`Service` = [`BaseActor`](https://ic-reactor.b3pay.net/v3/libs/type-aliases/baseactor/)

The actor interface type

### Method

`Method` *extends* [`FunctionName`](https://ic-reactor.b3pay.net/v3/libs/type-aliases/functionname/)\<`Service`\> = [`FunctionName`](https://ic-reactor.b3pay.net/v3/libs/type-aliases/functionname/)\<`Service`\>

The method name on the actor

### Transform

`Transform` *extends* [`TransformKey`](https://ic-reactor.b3pay.net/v3/libs/type-aliases/transformkey/) = `"candid"`

The transformation key (identity, display, etc.)

### TPageParam

`TPageParam` = `unknown`

The type of the page parameter

### Selected

`Selected` = `InfiniteData`\<[`InfiniteQueryPageData`](https://ic-reactor.b3pay.net/v3/libs/type-aliases/infinitequerypagedata/)\<`Service`, `Method`, `Transform`\>, `TPageParam`\>

The type returned after select transformation

## Properties

### functionName

> **functionName**: `Method`

Defined in: [react/src/createInfiniteQuery.ts:125](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/createInfiniteQuery.ts#L125)

The method to call on the canister

***

### callConfig?

> `optional` **callConfig?**: `CallConfig`

Defined in: [react/src/createInfiniteQuery.ts:127](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/createInfiniteQuery.ts#L127)

Call configuration for the actor method

***

### queryKey?

> `optional` **queryKey?**: readonly `unknown`[]

Defined in: [react/src/createInfiniteQuery.ts:129](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/createInfiniteQuery.ts#L129)

Custom query key (optional, auto-generated if not provided)

***

### initialPageParam

> **initialPageParam**: `TPageParam`

Defined in: [react/src/createInfiniteQuery.ts:131](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/createInfiniteQuery.ts#L131)

Initial page parameter

#### Overrides

`Omit.initialPageParam`

***

### getArgs

> **getArgs**: (`pageParam`) => [`ReactorArgs`](https://ic-reactor.b3pay.net/v3/libs/type-aliases/reactorargs/)\<`Service`, `Method`, `Transform`\>

Defined in: [react/src/createInfiniteQuery.ts:133](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/createInfiniteQuery.ts#L133)

Function to get args from page parameter

#### Parameters

##### pageParam

`TPageParam`

#### Returns

[`ReactorArgs`](https://ic-reactor.b3pay.net/v3/libs/type-aliases/reactorargs/)\<`Service`, `Method`, `Transform`\>

***

### getKeyArgs?

> `optional` **getKeyArgs?**: (`args`) => `unknown`

Defined in: [react/src/createInfiniteQuery.ts:143](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/createInfiniteQuery.ts#L143)

Narrows what the cache key derives from the call arguments.

By default the key is scoped by `getArgs(initialPageParam)`, so two
infinite queries on the same method with different arguments stay in
separate cache entries. Supply this when those args embed the cursor and
only part of them identifies the query — return the stable, serializable
portion (typically everything except the pagination field).

#### Parameters

##### args

[`ReactorArgs`](https://ic-reactor.b3pay.net/v3/libs/type-aliases/reactorargs/)\<`Service`, `Method`, `Transform`\>

#### Returns

`unknown`

***

### getNextPageParam

> **getNextPageParam**: (`lastPage`, `allPages`, `lastPageParam`, `allPageParams`) => `TPageParam` \| `null` \| `undefined`

Defined in: [react/src/createInfiniteQuery.ts:145](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/createInfiniteQuery.ts#L145)

Function to determine next page parameter

#### Parameters

##### lastPage

[`ReactorQueryData`](https://ic-reactor.b3pay.net/v3/libs/type-aliases/reactorquerydata/)\<[`ReactorReturnOk`](https://ic-reactor.b3pay.net/v3/libs/type-aliases/reactorreturnok/)\<`Service`, `Method`, `Transform`\>\>

##### allPages

[`ReactorQueryData`](https://ic-reactor.b3pay.net/v3/libs/type-aliases/reactorquerydata/)\<[`ReactorReturnOk`](https://ic-reactor.b3pay.net/v3/libs/type-aliases/reactorreturnok/)\<`Service`, `Method`, `Transform`\>\>[]

##### lastPageParam

`TPageParam`

##### allPageParams

`TPageParam`[]

#### Returns

`TPageParam` \| `null` \| `undefined`

#### Overrides

`Omit.getNextPageParam`

***

### getPreviousPageParam?

> `optional` **getPreviousPageParam?**: (`firstPage`, `allPages`, `firstPageParam`, `allPageParams`) => `TPageParam` \| `null` \| `undefined`

Defined in: [react/src/createInfiniteQuery.ts:152](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/createInfiniteQuery.ts#L152)

Function to determine previous page parameter (for bi-directional)

#### Parameters

##### firstPage

[`ReactorQueryData`](https://ic-reactor.b3pay.net/v3/libs/type-aliases/reactorquerydata/)\<[`ReactorReturnOk`](https://ic-reactor.b3pay.net/v3/libs/type-aliases/reactorreturnok/)\<`Service`, `Method`, `Transform`\>\>

##### allPages

[`ReactorQueryData`](https://ic-reactor.b3pay.net/v3/libs/type-aliases/reactorquerydata/)\<[`ReactorReturnOk`](https://ic-reactor.b3pay.net/v3/libs/type-aliases/reactorreturnok/)\<`Service`, `Method`, `Transform`\>\>[]

##### firstPageParam

`TPageParam`

##### allPageParams

`TPageParam`[]

#### Returns

`TPageParam` \| `null` \| `undefined`

#### Overrides

`Omit.getPreviousPageParam`