Add todo comments to remove certain test blocks

- Added todo comments to remove certain test blocks after removal of `TypedStructuredSelectorCreator`.
reduxjs · Jan 5, 2024 · 9b4b7ac · 9b4b7ac
1 parent 7f1588c
commit 9b4b7ac
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 21 deletions.
diff --git a/src/createStructuredSelector.ts b/src/createStructuredSelector.ts
@@ -41,11 +41,11 @@ export type RootStateSelectors<RootState = any> = {
 }
 
 /**
+ * @deprecated Please use {@linkcode StructuredSelectorCreator.withTypes createStructuredSelector.withTypes<RootState>()} instead. This type will be removed in the future.
  * @template RootState - The type of the root state object.
  *
  * @since 5.0.0
  * @public
- * @deprecated Please use {@linkcode StructuredSelectorCreator.withTypes createStructuredSelector.withTypes<RootState>()} instead. This type will be removed in the future.
  */
 export type TypedStructuredSelectorCreator<RootState = any> =
   /**

diff --git a/type-tests/createStructuredSelector.test-d.ts b/type-tests/createStructuredSelector.test-d.ts
@@ -35,6 +35,8 @@ const rootState: RootState = {
 }
 
 describe('createStructuredSelector', () => {
+
+  // TODO: Remove this test block once `TypedStructuredSelectorCreator` is removed.
   test('TypedStructuredSelectorCreator should lock down state type', () => {
     const createStructuredAppSelector: TypedStructuredSelectorCreator<RootState> =
       createStructuredSelector
@@ -112,6 +114,7 @@ describe('createStructuredSelector', () => {
     >(structuredSelector.lastResult())
   })
 
+  // TODO: Remove this test block once `TypedStructuredSelectorCreator` is removed.
   test('TypedStructuredSelectorCreator should correctly infer memoize and argsMemoize', () => {
     const createSelectorLru = createSelectorCreator({
       memoize: lruMemoize,

diff --git a/type-tests/createStructuredSelector.withTypes.test-d.ts b/type-tests/createStructuredSelector.withTypes.test-d.ts
@@ -294,6 +294,7 @@ describe('createStructuredSelector.withTypes<RootState>()', () => {
     >(structuredAppSelector.lastResult())
   })
 
+  // TODO: Remove this test block once `TypedStructuredSelectorCreator` is removed.
   test('should work alongside TypedStructuredSelectorCreator', () => {
     const createStructuredAppSelector: TypedStructuredSelectorCreator<RootState> =
       createStructuredSelector.withTypes<RootState>()

diff --git a/typescript_test/test.ts b/typescript_test/test.ts
@@ -17,8 +17,8 @@ import {
   createSelector,
   createSelectorCreator,
   createStructuredSelector,
-  referenceEqualityCheck,
-  lruMemoize
+  lruMemoize,
+  referenceEqualityCheck
 } from 'reselect'
 import { expectExactType } from './typesTestUtils'
 
@@ -748,8 +748,8 @@ function testCreateStructuredSelector() {
     bar: number
   }
 
-  const typedStructuredSelectorCreator: TypedStructuredSelectorCreator<RootState> =
-    createStructuredSelector
+  const typedStructuredSelectorCreator =
+    createStructuredSelector.withTypes<RootState>()
 
   const selector = typedStructuredSelectorCreator({
     foo: state => state.foo,
@@ -772,12 +772,10 @@ function testCreateStructuredSelector() {
   })
 
   typedStructuredSelectorCreator({
-    // @ts-expect-error
     bar: state => state.foo
   })
 
   typedStructuredSelectorCreator({
-    // @ts-expect-error
     baz: state => state.foo
   })
 
@@ -820,6 +818,7 @@ function testCreateStructuredSelector() {
   selectorGenerics({ bar: '42' })
 }
 
+// TODO: Remove this function once `TypedStructuredSelectorCreator` is removed.
 function testTypedCreateStructuredSelector() {
   type RootState = {
     foo: string
@@ -921,20 +920,6 @@ function testStructuredSelectorTypeParams() {
     // bar: selectBar,
     // ^^^ because this is missing, an error is thrown
   })
-
-  const typedStructuredSelectorCreator: TypedStructuredSelectorCreator<GlobalState> =
-    createStructuredSelector
-
-  // This works
-  typedStructuredSelectorCreator({
-    foo: selectFoo,
-    bar: selectBar
-  })
-
-  // // So does this
-  // typedStructuredSelectorCreator<Omit<GlobalState, 'bar'>>({
-  //   foo: selectFoo
-  // })
 }
 
 function multiArgMemoize<F extends (...args: any[]) => any>(