Export createImmutableStateInvariantMiddleware, fix typo (#449)

* Export createImmutableStateInvariantMiddleware, fix typo

* Add @public tag to new exports

Author: exogen

etc/redux-toolkit.api.md

@@ -136,6 +136,9 @@ export function createEntityAdapter<T>(options?: {
     sortComparer?: false | Comparer<T>;
 }): EntityAdapter<T>;
 
+// @public
+export function createImmutableStateInvariantMiddleware(options?: ImmutableStateInvariantMiddlewareOptions): Middleware;
+
 export { createNextState }
 
 // @public
@@ -213,6 +216,19 @@ export function getType<T extends string>(actionCreator: PayloadActionCreator<an
 // @alpha (undocumented)
 export type IdSelector<T> = (model: T) => EntityId;
 
+// @public
+export interface ImmutableStateInvariantMiddlewareOptions {
+    // (undocumented)
+    ignoredPaths?: string[];
+    // (undocumented)
+    isImmutable?: IsImmutableFunc;
+    // (undocumented)
+    warnAfter?: number;
+}
+
+// @public
+export function isImmutableDefault(value: unknown): boolean;
+
 // @public
 export function isPlain(val: any): boolean;
 

src/immutableStateInvariantMiddleware.ts

@@ -61,6 +61,11 @@ function getSerialize(
   }
 }
 
+/**
+ * The default `isImmutable` function.
+ *
+ * @public
+ */
 export function isImmutableDefault(value: unknown): boolean {
   return (
     typeof value !== 'object' || value === null || typeof value === 'undefined'
@@ -69,13 +74,13 @@ export function isImmutableDefault(value: unknown): boolean {
 
 export function trackForMutations(
   isImmutable: IsImmutableFunc,
-  ingorePaths: string[] | undefined,
+  ignorePaths: string[] | undefined,
   obj: any
 ) {
-  const trackedProperties = trackProperties(isImmutable, ingorePaths, obj)
+  const trackedProperties = trackProperties(isImmutable, ignorePaths, obj)
   return {
     detectMutations() {
-      return detectMutations(isImmutable, ingorePaths, trackedProperties, obj)
+      return detectMutations(isImmutable, ignorePaths, trackedProperties, obj)
     }
   }
 }
@@ -172,12 +177,27 @@ function detectMutations(
 }
 
 type IsImmutableFunc = (value: any) => boolean
+
+/**
+ * Options for `createImmutableStateInvariantMiddleware()`.
+ *
+ * @public
+ */
 export interface ImmutableStateInvariantMiddlewareOptions {
   isImmutable?: IsImmutableFunc
   ignoredPaths?: string[]
   warnAfter?: number
 }
 
+/**
+ * Creates a middleware that checks whether any state was mutated in between
+ * dispatches or during a dispatch. If any mutations are detected, an error is
+ * thrown.
+ *
+ * @param options Middleware options.
+ *
+ * @public
+ */
 export function createImmutableStateInvariantMiddleware(
   options: ImmutableStateInvariantMiddlewareOptions = {}
 ): Middleware {

src/index.ts

@@ -58,6 +58,13 @@ export {
   CaseReducerWithPrepare,
   SliceActionCreator
 } from './createSlice'
+export {
+  // js
+  createImmutableStateInvariantMiddleware,
+  isImmutableDefault,
+  // types
+  ImmutableStateInvariantMiddlewareOptions
+} from './immutableStateInvariantMiddleware'
 export {
   // js
   createSerializableStateInvariantMiddleware,