Document infinite query option fields

Author: markerikson

packages/toolkit/src/query/core/apiState.ts

@@ -38,7 +38,15 @@ export type PageParamFunction<DataType, PageParam> = (
 ) => PageParam | undefined | null
 
 export type InfiniteQueryConfigOptions<DataType, PageParam> = {
+  /**
+   * The initial page parameter to use for the first page fetch.
+   */
   initialPageParam: PageParam
+  /**
+   * If specified, only keep this many pages in cache at once.
+   * If additional pages are fetched, older pages in the other
+   * direction will be dropped from the cache.
+   */
   maxPages?: number
   /**
    * This function can be set to automatically get the previous cursor for infinite queries.

packages/toolkit/src/query/createApi.ts

@@ -98,7 +98,7 @@ export interface CreateApiOptions<
    */
   serializeQueryArgs?: SerializeQueryArgs<unknown>
   /**
-   * Endpoints are just a set of operations that you want to perform against your server. You define them as an object using the builder syntax. There are two basic endpoint types: [`query`](../../rtk-query/usage/queries) and [`mutation`](../../rtk-query/usage/mutations).
+   * Endpoints are a set of operations that you want to perform against your server. You define them as an object using the builder syntax. There are two basic endpoint types: [`query`](../../rtk-query/usage/queries) and [`mutation`](../../rtk-query/usage/mutations).
    */
   endpoints(
     build: EndpointBuilder<BaseQuery, TagTypes, ReducerPath>,

packages/toolkit/src/query/endpointDefinitions.ts

@@ -601,6 +601,12 @@ export interface InfiniteQueryExtraOptions<
    */
   invalidatesTags?: never
 
+  /**
+   * Required options to configure the infinite query behavior.
+   * `initialPageParam` and `getNextPageParam` are required, to
+   * ensure the infinite query can properly fetch the next page of data. `initialPageparam` may be specified when using the
+   * endpoint, to override the default value.
+   */
   infiniteQueryOptions: InfiniteQueryConfigOptions<ResultType, PageParam>
 
   /**