Skip to content

Assorted outstanding docs improvements #3738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
markerikson merged 7 commits into from
Sep 24, 2023
Merged

Assorted outstanding docs improvements #3738

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
78813fc
Clarify configureStore purpose and behavior
markerikson Sep 23, 2023
b3e50dc
Clarify extraReducers purpose
markerikson Sep 23, 2023
3718594
Fix broken links in matching utilities page
markerikson Sep 23, 2023
e45b0f5
Improve queryFn exampls
markerikson Sep 23, 2023
f2ecd03
Clarify TS generics for queries and mutations
markerikson Sep 23, 2023
3805c81
Add workaround for partial payloads
markerikson Sep 23, 2023
d7fb5ef
Link codemod
markerikson Sep 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix broken links in matching utilities page
  • Loading branch information
@markerikson
markerikson committed Sep 23, 2023
commit 371859447a3f55950342e2df75b497449ecc0abc
15 changes: 6 additions & 9 deletions docs/api/matching-utilities.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ All these matchers can either be called with one or more thunks as arguments, in
A higher-order function that accepts one or more of:

- `redux-toolkit` action creator functions such as the ones produced by:
- [`createAction`](./createAction)
- [`createSlice`](./createSlice#return-value)
- [`createAsyncThunk`](./createAsyncThunk#promise-lifecycle-actions)
- [`createAction`](./createAction.mdx)
- [`createSlice`](./createSlice.mdx#return-value)
- [`createAsyncThunk`](./createAsyncThunk.mdx#promise-lifecycle-actions)
- type guard functions
- custom action creator functions that have a `.match` property that is a type guard

Expand All @@ -45,7 +45,7 @@ Accepts the same inputs as `isAllOf` and will return a type guard function that

## `isAsyncThunkAction`

A higher-order function that returns a type guard function that may be used to check whether an action was created by [`createAsyncThunk`](./createAsyncThunk).
A higher-order function that returns a type guard function that may be used to check whether an action was created by [`createAsyncThunk`](./createAsyncThunk.mdx).

```ts title="isAsyncThunkAction usage"
import { isAsyncThunkAction } from '@reduxjs/toolkit'
Expand Down Expand Up @@ -117,7 +117,7 @@ function handleRejectedAction(action: AnyAction) {

## `isRejectedWithValue`

A higher-order function that returns a type guard function that may be used to check whether an action is a 'rejected' action creator from the `createAsyncThunk` promise lifecycle that was created by [`rejectWithValue`](./createAsyncThunk#handling-thunk-errors).
A higher-order function that returns a type guard function that may be used to check whether an action is a 'rejected' action creator from the `createAsyncThunk` promise lifecycle that was created by [`rejectWithValue`](./createAsyncThunk.mdx#handling-thunk-errors).

```ts title="isRejectedWithValue usage"
import { isRejectedWithValue } from '@reduxjs/toolkit'
Expand Down Expand Up @@ -145,10 +145,7 @@ we're able to easily use the same matcher for several cases in a type-safe manne
First, let's examine an unnecessarily complex example:

```ts title="Example without using a matcher utility"
import {
createAsyncThunk,
createReducer,
} from '@reduxjs/toolkit'
import { createAsyncThunk, createReducer } from '@reduxjs/toolkit'
import type { PayloadAction } from '@reduxjs/toolkit'

interface Data {
Expand Down