Skip to content

Commit 1899fb5

Browse files
kevin940726markerikson
authored andcommitted
Update doc for serializableStateInvariantMiddleware (#327)
* Update doc for serializableStateInvariantMiddleware * Attach anchor
1 parent 09cf179 commit 1899fb5

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/api/getDefaultMiddleware.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ provide runtime checks for two common issues:
5959
state values for mutations. It can detect mutations in reducers during a dispatch, and also mutations that occur between
6060
dispatches (such as in a component or a selector). When a mutation is detected, it will throw an error and indicate the key
6161
path for where the mutated value was detected in the state tree.
62-
- `serializable-state-invariant-middleware`: a custom middleware created specifically for use in Redux Toolkit. Similar in
62+
- [`serializable-state-invariant-middleware`](./otherExports.md#createserializablestateinvariantmiddleware): a custom middleware created specifically for use in Redux Toolkit. Similar in
6363
concept to `redux-immutable-state-invariant`, but deeply checks your state tree and your actions for non-serializable values
6464
such as functions, Promises, Symbols, and other non-plain-JS-data values. When a non-serializable value is detected, a
6565
console error will be printed with the key path for where the non-serializable value was detected.
@@ -130,6 +130,11 @@ interface SerializableStateInvariantMiddlewareOptions {
130130
* An array of action types to ignore when checking for serializability, Defaults to []
131131
*/
132132
ignoredActions?: string[]
133+
134+
/**
135+
* An array of dot-separated path strings to ignore when checking for serializability, Defaults to []
136+
*/
137+
ignoredPaths?: string[]
133138
}
134139

135140
interface GetDefaultMiddlewareOptions {

0 commit comments

Comments
 (0)