Add API docs for new utils

reduxjs · Nov 25, 2023 · 47cf3a5 · 47cf3a5
1 parent 97d0992
commit 47cf3a5
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/docs/api/utils.md b/docs/api/utils.md
@@ -0,0 +1,22 @@
+---
+id: utils
+title: Additional Utilities
+hide_title: true
+description: 'API > utils: Additional utility functions'
+---
+
+&nbsp;
+
+# Utility Functions
+
+The Redux core exports additional utility functions for reuse.
+
+## `isAction`
+
+Returns true if the parameter is a valid Redux action object (a plain object with a string `type` field).
+
+This also serves as a TypeScript type predicate, which will narrow the TS type to `Action<string>`.
+
+## `isPlainObject`
+
+Returns true if the value appears to be a plain JS object.
diff --git a/website/sidebars.js b/website/sidebars.js
@@ -151,6 +151,7 @@ module.exports = {
       'api/applymiddleware',
       'api/bindactioncreators',
       'api/compose',
+      'api/utils',
       { type: 'link', label: 'Error Messages', href: '/errors' }
     ],
     'Redux Toolkit': ['redux-toolkit/overview']