refactor(*): change noop function return type from undefined to void (#…

…8299) * refactor(*): use noop * refactor: separate noop and returnUndefined functions with type refinement Co-authored-by: Jonghyeon Ko <[email protected]> Co-authored-by: Sol Lee <[email protected]> * refactor: optimize bundle size with type re-assertion * fix: Prevent type error by overloading noop function * fix: remove jsdoc * fix * revert * revert at react-query and angular-query-experimental --------- Co-authored-by: Jonghyeon Ko <[email protected]> Co-authored-by: Sol Lee <[email protected]> Co-authored-by: Dominik Dorfmeister <[email protected]>
TanStack · Nov 19, 2024 · 7d36089 · 7d36089
1 parent fadfbde
commit 7d36089
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 11 deletions.
diff --git a/packages/angular-query-experimental/src/providers.ts b/packages/angular-query-experimental/src/providers.ts
@@ -12,6 +12,7 @@ import {
 import { QueryClient, onlineManager } from '@tanstack/query-core'
 import { isPlatformBrowser } from '@angular/common'
 import { isDevMode } from './util/is-dev-mode/is-dev-mode'
+import { noop } from './util'
 import type { EnvironmentProviders, Provider } from '@angular/core'
 import type {
   DevtoolsButtonPosition,
@@ -251,7 +252,7 @@ export function withDevtools(
         provide: ENVIRONMENT_INITIALIZER,
         multi: true,
         useFactory: () => {
-          if (!isPlatformBrowser(inject(PLATFORM_ID))) return () => {}
+          if (!isPlatformBrowser(inject(PLATFORM_ID))) return noop
           const injector = inject(Injector)
           const options = computed(() =>
             runInInjectionContext(injector, () => optionsFn?.() ?? {}),

diff --git a/packages/query-async-storage-persister/src/utils.ts b/packages/query-async-storage-persister/src/utils.ts
@@ -1 +1,3 @@
-export function noop(): void {}
+export function noop(): void
+export function noop(): undefined
+export function noop() {}
diff --git a/packages/query-core/src/utils.ts b/packages/query-core/src/utils.ts
@@ -68,9 +68,9 @@ export type QueryTypeFilter = 'all' | 'active' | 'inactive'
 
 export const isServer = typeof window === 'undefined' || 'Deno' in globalThis
 
-export function noop(): undefined {
-  return undefined
-}
+export function noop(): void
+export function noop(): undefined
+export function noop() {}
 
 export function functionalUpdate<TInput, TOutput>(
   updater: Updater<TInput, TOutput>,

diff --git a/packages/query-sync-storage-persister/src/index.ts b/packages/query-sync-storage-persister/src/index.ts
@@ -88,7 +88,7 @@ export function createSyncStoragePersister({
 
   return {
     persistClient: noop,
-    restoreClient: () => undefined,
+    restoreClient: noop,
     removeClient: noop,
   }
 }

diff --git a/packages/query-sync-storage-persister/src/utils.ts b/packages/query-sync-storage-persister/src/utils.ts
@@ -1 +1,3 @@
-export function noop(): void {}
+export function noop(): void
+export function noop(): undefined
+export function noop() {}
diff --git a/packages/svelte-query/src/createBaseQuery.ts b/packages/svelte-query/src/createBaseQuery.ts
@@ -2,7 +2,7 @@ import { derived, get, readable } from 'svelte/store'
 import { notifyManager } from '@tanstack/query-core'
 import { useIsRestoring } from './useIsRestoring.js'
 import { useQueryClient } from './useQueryClient.js'
-import { isSvelteStore } from './utils.js'
+import { isSvelteStore, noop } from './utils.js'
 import type {
   QueryClient,
   QueryKey,
@@ -66,7 +66,7 @@ export function createBaseQuery<
     QueryObserverResult<TData, TError>
   >(isRestoring, ($isRestoring, set) => {
     const unsubscribe = $isRestoring
-      ? () => undefined
+      ? noop
       : observer.subscribe(notifyManager.batchCalls(set))
     observer.updateResult()
     return unsubscribe

diff --git a/packages/svelte-query/src/createQueries.ts b/packages/svelte-query/src/createQueries.ts
@@ -2,7 +2,7 @@ import { QueriesObserver, notifyManager } from '@tanstack/query-core'
 import { derived, get, readable } from 'svelte/store'
 import { useIsRestoring } from './useIsRestoring.js'
 import { useQueryClient } from './useQueryClient.js'
-import { isSvelteStore } from './utils.js'
+import { isSvelteStore, noop } from './utils.js'
 import type { Readable } from 'svelte/store'
 import type { StoreOrVal } from './types.js'
 import type {
@@ -253,7 +253,7 @@ export function createQueries<
 
   const result = derived([isRestoring], ([$isRestoring], set) => {
     const unsubscribe = $isRestoring
-      ? () => undefined
+      ? noop
       : observer.subscribe(notifyManager.batchCalls(set))
 
     return () => unsubscribe()