React Example: UseAsyncDebouncer

Github StackBlitz CodeSandbox

import { useState } from 'react' import ReactDOM from 'react-dom/client' import { useAsyncDebouncer } from '@tanstack/react-pacer/async-debouncer' interface SearchResult { id: number title: string } // Simulate API call with fake data const fakeApi = async (term: string): Promise<Array<SearchResult>> => { await new Promise((resolve) => setTimeout(resolve, 500)) // Simulate network delay return [ { id: 1, title: `${term} result ${Math.floor(Math.random() * 100)}` }, { id: 2, title: `${term} result ${Math.floor(Math.random() * 100)}` }, { id: 3, title: `${term} result ${Math.floor(Math.random() * 100)}` }, ] } function App() { const [searchTerm, setSearchTerm] = useState('') const [results, setResults] = useState<Array<SearchResult>>([]) // The function that will become debounced const handleSearch = async (term: string) => { throw new Error('Test error') if (!term) { setResults([]) return } // throw new Error('Test error') // you don't have to catch errors here (though you still can). The onError optional handler will catch it const data = await fakeApi(term) setResults(data) return data // this could alternatively be a void function without a return } // hook that gives you an async debouncer instance const asyncDebouncer = useAsyncDebouncer( handleSearch, { // leading: true, // optional leading execution wait: 500, // Wait 500ms between API calls onError: (error) => { // optional error handler console.error('Search failed:', error) setResults([]) }, // throwOnError: true, }, // Optional Selector function to pick the state you want to track and use (state) => ({ isExecuting: state.isExecuting, isPending: state.isPending, successCount: state.successCount, }), ) // get and name our debounced function const handleSearchDebounced = asyncDebouncer.maybeExecute // instant event handler that calls both the instant local state setter and the debounced function async function onSearchChange(e: React.ChangeEvent<HTMLInputElement>) { const newTerm = e.target.value setSearchTerm(newTerm) const result = await handleSearchDebounced(newTerm) // optionally await result if you need to console.log('result', result) } return ( <div> <h1>TanStack Pacer useAsyncDebouncer Example</h1> <div> <input autoFocus type="search" value={searchTerm} onChange={onSearchChange} placeholder="Type to search..." style={{ width: '100%' }} autoComplete="new-password" /> </div> <div style={{ marginTop: '10px' }}> <button onClick={() => asyncDebouncer.flush()}>Flush</button> </div> <div> <p>API calls made: {asyncDebouncer.state.successCount}</p> {results.length > 0 && ( <ul> {results.map((item) => ( <li key={item.id}>{item.title}</li> ))} </ul> )} {asyncDebouncer.state.isPending && <p>Pending...</p>} {asyncDebouncer.state.isExecuting && <p>Executing...</p>} <pre style={{ marginTop: '20px' }}> {JSON.stringify(asyncDebouncer.store.state, null, 2)} </pre> </div> </div> ) } const root = ReactDOM.createRoot(document.getElementById('root')!) let mounted = true root.render(<App />) // demo unmounting and cancellation document.addEventListener('keydown', (e) => { if (e.shiftKey && e.key === 'Enter') { mounted = !mounted root.render(mounted ? <App /> : null) } }) 

import { useState } from 'react' import ReactDOM from 'react-dom/client' import { useAsyncDebouncer } from '@tanstack/react-pacer/async-debouncer' interface SearchResult { id: number title: string } // Simulate API call with fake data const fakeApi = async (term: string): Promise<Array<SearchResult>> => { await new Promise((resolve) => setTimeout(resolve, 500)) // Simulate network delay return [ { id: 1, title: `${term} result ${Math.floor(Math.random() * 100)}` }, { id: 2, title: `${term} result ${Math.floor(Math.random() * 100)}` }, { id: 3, title: `${term} result ${Math.floor(Math.random() * 100)}` }, ] } function App() { const [searchTerm, setSearchTerm] = useState('') const [results, setResults] = useState<Array<SearchResult>>([]) // The function that will become debounced const handleSearch = async (term: string) => { throw new Error('Test error') if (!term) { setResults([]) return } // throw new Error('Test error') // you don't have to catch errors here (though you still can). The onError optional handler will catch it const data = await fakeApi(term) setResults(data) return data // this could alternatively be a void function without a return } // hook that gives you an async debouncer instance const asyncDebouncer = useAsyncDebouncer( handleSearch, { // leading: true, // optional leading execution wait: 500, // Wait 500ms between API calls onError: (error) => { // optional error handler console.error('Search failed:', error) setResults([]) }, // throwOnError: true, }, // Optional Selector function to pick the state you want to track and use (state) => ({ isExecuting: state.isExecuting, isPending: state.isPending, successCount: state.successCount, }), ) // get and name our debounced function const handleSearchDebounced = asyncDebouncer.maybeExecute // instant event handler that calls both the instant local state setter and the debounced function async function onSearchChange(e: React.ChangeEvent<HTMLInputElement>) { const newTerm = e.target.value setSearchTerm(newTerm) const result = await handleSearchDebounced(newTerm) // optionally await result if you need to console.log('result', result) } return ( <div> <h1>TanStack Pacer useAsyncDebouncer Example</h1> <div> <input autoFocus type="search" value={searchTerm} onChange={onSearchChange} placeholder="Type to search..." style={{ width: '100%' }} autoComplete="new-password" /> </div> <div style={{ marginTop: '10px' }}> <button onClick={() => asyncDebouncer.flush()}>Flush</button> </div> <div> <p>API calls made: {asyncDebouncer.state.successCount}</p> {results.length > 0 && ( <ul> {results.map((item) => ( <li key={item.id}>{item.title}</li> ))} </ul> )} {asyncDebouncer.state.isPending && <p>Pending...</p>} {asyncDebouncer.state.isExecuting && <p>Executing...</p>} <pre style={{ marginTop: '20px' }}> {JSON.stringify(asyncDebouncer.store.state, null, 2)} </pre> </div> </div> ) } const root = ReactDOM.createRoot(document.getElementById('root')!) let mounted = true root.render(<App />) // demo unmounting and cancellation document.addEventListener('keydown', (e) => { if (e.shiftKey && e.key === 'Enter') { mounted = !mounted root.render(mounted ? <App /> : null) } })