函数: createAsyncDebouncer()

function createAsyncDebouncer<TFn, TSelected>(
   fn, 
   initialOptions, 
selector): SolidAsyncDebouncer<TFn, TSelected>

function createAsyncDebouncer<TFn, TSelected>(
   fn, 
   initialOptions, 
selector): SolidAsyncDebouncer<TFn, TSelected>

定义于: async-debouncer/createAsyncDebouncer.ts:118

一个底层的 Solid hook，用于创建 AsyncDebouncer 实例，以延迟异步函数的执行。

此 hook 设计得非常灵活且与状态管理无关 - 它仅仅返回一个 debouncer 实例，您可以将其集成到任何状态管理解决方案中（createSignal 等）。

异步防抖确保异步函数仅在自上次调用以来经过指定的延迟后执行。每次新调用都会重置延迟计时器。这对于处理频繁事件（如窗口大小调整或输入更改）非常有用，当您希望在事件停止发生后执行处理程序时。

与节流（节流允许在固定间隔内执行）不同，防抖会阻止任何执行，直到函数在指定的延迟时间内停止被调用。

与非异步 Debouncer 不同，此异步版本支持从防抖函数返回的值，这使其成为 API 调用和其他异步操作的理想选择，您希望在 maybeExecute 调用中获取结果，而不是在防抖函数内部将结果设置到状态变量中。

错误处理

如果提供了 onError 处理程序，它将使用错误和 debouncer 实例被调用
如果 throwOnError 为 true（当没有提供 onError 处理程序时的默认值），错误将被抛出
如果 throwOnError 为 false（当提供 onError 处理程序时的默认值），错误将被吞没
onError 和 throwOnError 可以一起使用 - 在任何错误被抛出之前，处理程序都会被调用
可以通过检查底层的 AsyncDebouncer 实例来检查错误状态

状态管理和选择器

该 hook 使用 TanStack Store 进行响应式状态管理。 selector 参数允许您指定哪些状态更改将触发重新渲染，从而通过防止不相关的状态更改导致不必要的重新渲染来优化性能。

默认情况下，不会进行响应式状态订阅，您必须通过提供选择器函数来选择启用状态跟踪。这可以防止不必要的重新渲染，并让您完全控制组件何时更新。只有当您提供选择器时，组件才会随着所选状态值的变化而重新渲染。

可用的状态属性

canLeadingExecute: debouncer 是否可以在前沿执行
executionCount: 已完成的函数执行次数
hasError: 上次执行是否导致错误
isPending: 防抖器是否正在等待超时触发执行
isExecuting: 当前是否有异步函数执行正在进行中
lastArgs: Последний вызов maybeExecute 的参数
lastError: 最近一次失败执行的错误（如果有）
lastResult: 最近一次成功执行的结果
status: 当前执行状态 ('disabled' | 'idle' | 'pending' | 'executing')

// Default behavior - no reactive state subscriptions
const { maybeExecute } = createAsyncDebouncer(
  async (query: string) => {
    const results = await api.search(query);
    return results;
  },
  { wait: 500 }
);

// Opt-in to re-render when isPending or isExecuting changes (optimized for loading states)
const debouncer = createAsyncDebouncer(
  async (query: string) => {
    const results = await api.search(query);
    return results;
  },
  { wait: 500 },
  (state) => ({ isPending: state.isPending, isExecuting: state.isExecuting })
);

// Opt-in to re-render when error state changes (optimized for error handling)
const debouncer = createAsyncDebouncer(
  async (searchTerm) => {
    const data = await searchAPI(searchTerm);
    return data;
  },
  {
    wait: 300,
    leading: true,   // Execute immediately on first call
    trailing: false, // Skip trailing edge updates
    onError: (error) => {
      console.error('API call failed:', error);
    }
  },
  (state) => ({ hasError: state.hasError, lastError: state.lastError })
);

// Access the selected state (will be empty object {} unless selector provided)
const { isPending, isExecuting } = debouncer.state();

// Default behavior - no reactive state subscriptions
const { maybeExecute } = createAsyncDebouncer(
  async (query: string) => {
    const results = await api.search(query);
    return results;
  },
  { wait: 500 }
);

// Opt-in to re-render when isPending or isExecuting changes (optimized for loading states)
const debouncer = createAsyncDebouncer(
  async (query: string) => {
    const results = await api.search(query);
    return results;
  },
  { wait: 500 },
  (state) => ({ isPending: state.isPending, isExecuting: state.isExecuting })
);

// Opt-in to re-render when error state changes (optimized for error handling)
const debouncer = createAsyncDebouncer(
  async (searchTerm) => {
    const data = await searchAPI(searchTerm);
    return data;
  },
  {
    wait: 300,
    leading: true,   // Execute immediately on first call
    trailing: false, // Skip trailing edge updates
    onError: (error) => {
      console.error('API call failed:', error);
    }
  },
  (state) => ({ hasError: state.hasError, lastError: state.lastError })
);

// Access the selected state (will be empty object {} unless selector provided)
const { isPending, isExecuting } = debouncer.state();

createAsyncDebouncer

函数: createAsyncDebouncer()

状态管理和选择器

类型参数

参数

fn

initialOptions

选择器

Returns (返回)

示例

订阅 Bytes

订阅 Bytes