Skip to content

Commit 695be4d

Browse files
committed
add required type parameter to EntityState in docs
1 parent 979f933 commit 695be4d

File tree

2 files changed

+13
-17
lines changed

2 files changed

+13
-17
lines changed

docs/rtk-query/usage/customizing-queries.mdx

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,11 @@ argument, which can be used while determining the transformed response. The valu
205205
dependent on the `baseQuery` used.
206206

207207
```ts title="transformErrorResponse meta example" no-transpile
208-
transformErrorResponse: (response: { data: { sideA: Tracks; sideB: Tracks } }, meta, arg) => {
208+
transformErrorResponse: (
209+
response: { data: { sideA: Tracks; sideB: Tracks } },
210+
meta,
211+
arg
212+
) => {
209213
if (meta?.coinFlip === 'heads') {
210214
return response.data.sideA
211215
}
@@ -318,7 +322,7 @@ const axiosBaseQuery =
318322
return {
319323
error: {
320324
status: err.response?.status,
321-
data: err.response?.data || err.message
325+
data: err.response?.data || err.message,
322326
},
323327
}
324328
}
@@ -610,10 +614,7 @@ In such a scenario, the return value would look like so:
610614
export declare const uuid: () => string
611615

612616
// file: metaBaseQuery.ts
613-
import {
614-
fetchBaseQuery,
615-
createApi,
616-
} from '@reduxjs/toolkit/query'
617+
import { fetchBaseQuery, createApi } from '@reduxjs/toolkit/query'
617618
import type {
618619
BaseQueryFn,
619620
FetchArgs,
@@ -710,10 +711,7 @@ export interface Post {
710711
}
711712
712713
// file: src/services/api.ts
713-
import {
714-
createApi,
715-
fetchBaseQuery,
716-
} from '@reduxjs/toolkit/query/react'
714+
import { createApi, fetchBaseQuery } from '@reduxjs/toolkit/query/react'
717715
import type {
718716
BaseQueryFn,
719717
FetchArgs,
@@ -864,7 +862,7 @@ const postsAdapter = createEntityAdapter<Post>({
864862
export const api = createApi({
865863
baseQuery: fetchBaseQuery({ baseUrl: '/' }),
866864
endpoints: (build) => ({
867-
getPosts: build.query<EntityState<Post>, void>({
865+
getPosts: build.query<EntityState<Post, number>, void>({
868866
query: () => `posts`,
869867
// highlight-start
870868
transformResponse(response: Post[]) {
@@ -987,10 +985,7 @@ export interface User {
987985
}
988986

989987
// file: api.ts
990-
import {
991-
createApi,
992-
fetchBaseQuery,
993-
} from '@reduxjs/toolkit/query'
988+
import { createApi, fetchBaseQuery } from '@reduxjs/toolkit/query'
994989
import type { FetchBaseQueryError } from '@reduxjs/toolkit/query'
995990
import type { Post, User } from './types'
996991

@@ -1001,7 +996,8 @@ const api = createApi({
1001996
async queryFn(_arg, _queryApi, _extraOptions, fetchWithBQ) {
1002997
// get a random user
1003998
const randomResult = await fetchWithBQ('users/random')
1004-
if (randomResult.error) return { error: randomResult.error as FetchBaseQueryError }
999+
if (randomResult.error)
1000+
return { error: randomResult.error as FetchBaseQueryError }
10051001
const user = randomResult.data as User
10061002
const result = await fetchWithBQ(`user/${user.id}/posts`)
10071003
return result.data

docs/rtk-query/usage/streaming-updates.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ export const api = createApi({
158158
baseQuery: fetchBaseQuery({ baseUrl: '/' }),
159159
endpoints: (build) => ({
160160
// highlight-start
161-
getMessages: build.query<EntityState<Message>, Channel>({
161+
getMessages: build.query<EntityState<Message, number>, Channel>({
162162
// highlight-end
163163
query: (channel) => `messages/${channel}`,
164164
// highlight-start

0 commit comments

Comments
 (0)