Skip to content

Commit 4048cda

Browse files
EskiMojo14markerikson
authored andcommitted
resultSchema -> responseSchema
1 parent 810cbaf commit 4048cda

File tree

4 files changed

+16
-17
lines changed

4 files changed

+16
-17
lines changed

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

+5-5
Original file line numberDiff line numberDiff line change
@@ -555,7 +555,7 @@ export function buildThunks<
555555
finalQueryArg: unknown,
556556
): Promise<QueryReturnValue> {
557557
let result: QueryReturnValue
558-
const { extraOptions, argSchema, rawResultSchema, resultSchema } =
558+
const { extraOptions, argSchema, rawResponseSchema, responseSchema } =
559559
endpointDefinition
560560

561561
if (argSchema) {
@@ -617,8 +617,8 @@ export function buildThunks<
617617

618618
let { data } = result
619619

620-
if (rawResultSchema) {
621-
data = await parseWithSchema(rawResultSchema, result.data)
620+
if (rawResponseSchema) {
621+
data = await parseWithSchema(rawResponseSchema, result.data)
622622
}
623623

624624
let transformedResponse = await transformResponse(
@@ -627,9 +627,9 @@ export function buildThunks<
627627
finalQueryArg,
628628
)
629629

630-
if (resultSchema) {
630+
if (responseSchema) {
631631
transformedResponse = await parseWithSchema(
632-
resultSchema,
632+
responseSchema,
633633
transformedResponse,
634634
)
635635
}

packages/toolkit/src/query/endpointDefinitions.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ type EndpointDefinitionWithQuery<
105105
): unknown
106106

107107
/** A schema for the result *before* it's passed to `transformResponse` */
108-
rawResultSchema?: StandardSchemaV1<BaseQueryResult<BaseQuery>>
108+
rawResponseSchema?: StandardSchemaV1<BaseQueryResult<BaseQuery>>
109109

110110
/** A schema for the error object returned by the `query` or `queryFn`, *before* it's passed to `transformErrorResponse` */
111111
rawErrorSchema?: StandardSchemaV1<BaseQueryError<BaseQuery>>
@@ -169,7 +169,7 @@ type EndpointDefinitionWithQueryFn<
169169
query?: never
170170
transformResponse?: never
171171
transformErrorResponse?: never
172-
rawResultSchema?: never
172+
rawResponseSchema?: never
173173
rawErrorSchema?: never
174174
}
175175

@@ -193,7 +193,7 @@ export type BaseEndpointDefinition<
193193
argSchema?: StandardSchemaV1<QueryArg>
194194

195195
/** A schema for the result (including `transformResponse` if provided) */
196-
resultSchema?: StandardSchemaV1<ResultType>
196+
responseSchema?: StandardSchemaV1<ResultType>
197197

198198
/** A schema for the error object returned by the `query` or `queryFn` (including `transformErrorResponse` if provided) */
199199
errorSchema?: StandardSchemaV1<BaseQueryError<BaseQuery>>

packages/toolkit/src/query/tests/createApi.test-d.ts

+6-7
Original file line numberDiff line numberDiff line change
@@ -398,7 +398,7 @@ describe('type tests', () => {
398398
query: build.query<Post, { id: number }>({
399399
query: ({ id }) => `/post/${id}`,
400400
argSchema,
401-
resultSchema: postSchema,
401+
responseSchema: postSchema,
402402
errorSchema,
403403
metaSchema,
404404
}),
@@ -407,7 +407,7 @@ describe('type tests', () => {
407407
// @ts-expect-error wrong schema
408408
argSchema: v.object({ id: v.string() }),
409409
// @ts-expect-error wrong schema
410-
resultSchema: v.object({ id: v.string() }),
410+
responseSchema: v.object({ id: v.string() }),
411411
// @ts-expect-error wrong schema
412412
errorSchema: v.object({ status: v.string() }),
413413
// @ts-expect-error wrong schema
@@ -420,7 +420,7 @@ describe('type tests', () => {
420420
id: v.pipe(v.string(), v.transform(Number), v.number()),
421421
}),
422422
// @ts-expect-error can't expect different input
423-
resultSchema: v.object({
423+
responseSchema: v.object({
424424
...postSchema.entries,
425425
id: v.pipe(v.string(), v.transform(Number)),
426426
}) satisfies v.GenericSchema<any, Post>,
@@ -445,7 +445,7 @@ describe('type tests', () => {
445445
id: v.pipe(v.number(), v.transform(String)),
446446
}),
447447
// @ts-expect-error can't provide different output
448-
resultSchema: v.object({
448+
responseSchema: v.object({
449449
...postSchema.entries,
450450
id: v.pipe(v.number(), v.transform(String)),
451451
}) satisfies v.GenericSchema<Post, any>,
@@ -471,9 +471,8 @@ describe('type tests', () => {
471471
baseQuery: fetchBaseQuery({ baseUrl: 'https://example.com' }),
472472
endpoints: (build) => ({
473473
query: build.query({
474-
query: ({ id }) => `/post/${id}`,
475-
argSchema,
476-
resultSchema: postSchema,
474+
query: ({ id }: { id: number }) => `/post/${id}`,
475+
responseSchema: postSchema,
477476
}),
478477
}),
479478
})

packages/toolkit/src/query/tests/createApi.test.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1233,7 +1233,7 @@ describe('endpoint schemas', () => {
12331233
endpoints: (build) => ({
12341234
query: build.query<{ success: boolean }, void>({
12351235
query: () => '/success',
1236-
rawResultSchema: v.object({ value: v.literal('success!') }),
1236+
rawResponseSchema: v.object({ value: v.literal('success!') }),
12371237
}),
12381238
}),
12391239
})
@@ -1250,7 +1250,7 @@ describe('endpoint schemas', () => {
12501250
query: build.query<{ success: boolean }, void>({
12511251
query: () => '/success',
12521252
transformResponse: () => ({ success: false }),
1253-
resultSchema: v.object({ success: v.literal(true) }),
1253+
responseSchema: v.object({ success: v.literal(true) }),
12541254
}),
12551255
}),
12561256
})

0 commit comments

Comments
 (0)