Skip to content

Commit 0b7d07d

Browse files
committed
move common option to common options section
1 parent e8d8162 commit 0b7d07d

File tree

1 file changed

+14
-26
lines changed

1 file changed

+14
-26
lines changed

packages/toolkit/src/query/endpointDefinitions.ts

Lines changed: 14 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -103,19 +103,6 @@ type EndpointDefinitionWithQuery<
103103
meta: BaseQueryMeta<BaseQuery>,
104104
arg: QueryArg,
105105
): unknown
106-
/**
107-
* Defaults to `true`.
108-
*
109-
* Most apps should leave this setting on. The only time it can be a performance issue
110-
* is if an API returns extremely large amounts of data (e.g. 10,000 rows per request) and
111-
* you're unable to paginate it.
112-
*
113-
* For details of how this works, please see the below. When it is set to `false`,
114-
* every request will cause subscribed components to rerender, even when the data has not changed.
115-
*
116-
* @see https://redux-toolkit.js.org/api/other-exports#copywithstructuralsharing
117-
*/
118-
structuralSharing?: boolean
119106

120107
/** A schema for the result *before* it's passed to `transformResponse` */
121108
rawResultSchema?: StandardSchemaV1<BaseQueryResult<BaseQuery>>
@@ -184,19 +171,6 @@ type EndpointDefinitionWithQueryFn<
184171
transformErrorResponse?: never
185172
rawResultSchema?: never
186173
rawErrorSchema?: never
187-
/**
188-
* Defaults to `true`.
189-
*
190-
* Most apps should leave this setting on. The only time it can be a performance issue
191-
* is if an API returns extremely large amounts of data (e.g. 10,000 rows per request) and
192-
* you're unable to paginate it.
193-
*
194-
* For details of how this works, please see the below. When it is set to `false`,
195-
* every request will cause subscribed components to rerender, even when the data has not changed.
196-
*
197-
* @see https://redux-toolkit.js.org/api/other-exports#copywithstructuralsharing
198-
*/
199-
structuralSharing?: boolean
200174
}
201175

202176
type BaseEndpointTypes<QueryArg, BaseQuery extends BaseQueryFn, ResultType> = {
@@ -227,6 +201,20 @@ export type BaseEndpointDefinition<
227201
/** A schema for the `meta` property returned by the `query` or `queryFn` */
228202
metaSchema?: StandardSchemaV1<BaseQueryMeta<BaseQuery>>
229203

204+
/**
205+
* Defaults to `true`.
206+
*
207+
* Most apps should leave this setting on. The only time it can be a performance issue
208+
* is if an API returns extremely large amounts of data (e.g. 10,000 rows per request) and
209+
* you're unable to paginate it.
210+
*
211+
* For details of how this works, please see the below. When it is set to `false`,
212+
* every request will cause subscribed components to rerender, even when the data has not changed.
213+
*
214+
* @see https://redux-toolkit.js.org/api/other-exports#copywithstructuralsharing
215+
*/
216+
structuralSharing?: boolean
217+
230218
/* phantom type */
231219
[resultType]?: ResultType
232220
/* phantom type */

0 commit comments

Comments
 (0)