Add note on selectFromResult

markerikson · markerikson · commit 7c90bfd125dc · 2025-05-06T18:01:48.000-04:00
diff --git a/packages/toolkit/src/query/react/buildHooks.ts b/packages/toolkit/src/query/react/buildHooks.ts
@@ -1117,6 +1117,7 @@ export type UseInfiniteQueryStateOptions<
    * `selectFromResult` allows you to get a specific segment from a query result in a performant manner.
    * When using this feature, the component will not rerender unless the underlying data of the selected item has changed.
    * If the selected item is one element in a larger collection, it will disregard changes to elements in the same collection.
+   * Note that this should always return an object (not a primitive), as RTKQ adds fields to the return value.
    *
    * @example
    * ```ts

Original file line number	Diff line number	Diff line change
`@@ -1117,6 +1117,7 @@ export type UseInfiniteQueryStateOptions<`
`1117`	`1117`	* `selectFromResult` allows you to get a specific segment from a query result in a performant manner.
`1118`	`1118`	`* When using this feature, the component will not rerender unless the underlying data of the selected item has changed.`
`1119`	`1119`	`* If the selected item is one element in a larger collection, it will disregard changes to elements in the same collection.`
	`1120`	`+ * Note that this should always return an object (not a primitive), as RTKQ adds fields to the return value.`
`1120`	`1121`	`*`
`1121`	`1122`	`* @example`
`1122`	`1123`	* ```ts