From dda4e950b18d784e18eb20afb9c9339b69fbf03c Mon Sep 17 00:00:00 2001 From: Matt Sutkowski Date: Fri, 17 Apr 2020 21:36:15 -0700 Subject: [PATCH] Add missing parameters to docs for serializable middleware --- docs/api/getDefaultMiddleware.md | 12 ++++++++++++ docs/api/otherExports.md | 10 ++++++++-- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/docs/api/getDefaultMiddleware.md b/docs/api/getDefaultMiddleware.md index ac51a106d3..254b843c34 100644 --- a/docs/api/getDefaultMiddleware.md +++ b/docs/api/getDefaultMiddleware.md @@ -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 { diff --git a/docs/api/otherExports.md b/docs/api/otherExports.md index 4a5b5af99a..8ef686631a 100644 --- a/docs/api/otherExports.md +++ b/docs/api/otherExports.md @@ -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 }) ```