Skip to content
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.

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

Add missing parameters to docs for serializable middleware #510

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 12 additions & 0 deletions docs/api/getDefaultMiddleware.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,10 +132,22 @@ interface SerializableStateInvariantMiddlewareOptions {
*/
ignoredActions?: string[]

/**
* An array of dot-separated path strings to ignore when checking for serializability, Defaults to ['meta.arg']
* If you use this parameter, the default value 'meta.arg' will be removed, so we recommend re-adding it unless you
* specifically do not want to ignore it. Example: ['meta.arg', 'your.path', 'other.path', ...etc]
*/
ignoredActionPaths?: string[]

/**
* An array of dot-separated path strings to ignore when checking for serializability, Defaults to []
*/
ignoredPaths?: string[]

/**
* Execution time warning threshold. If the middleware takes longer than `warnAfter` ms, a warning will be displayed in the console. Defaults to 32
*/
warnAfter?: number
}

interface GetDefaultMiddlewareOptions {
Expand Down
10 changes: 8 additions & 2 deletions docs/api/otherExports.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,15 @@ function createSerializableStateInvariantMiddleware({
// An array of action types to ignore when checking for serializability.
// Defaults to []
ignoredActions?: string[]
// An array of dot-separated path strings to ignore when checking for serializability.
// Defaults to []
// An array of dot-separated path strings to ignore when
// checking for serializability, Defaults to ['meta.arg']
ignoredActionPaths?: string[]
// An array of dot-separated path strings to ignore when
// checking for serializability, Defaults to []
ignoredPaths?: string[]
// Execution time warning threshold. If the middleware takes longer
// than `warnAfter` ms, a warning will be displayed in the console. Defaults to 32
warnAfter?: number
})
```

Expand Down