框架
版本
防抖器 API 参考
节流器 API 参考
速率限制器 API 参考
队列 API 参考
批处理器 API 参考

createAsyncBatcher

函数: createAsyncBatcher()

ts
function createAsyncBatcher<TValue, TSelected>(
   fn, 
   initialOptions, 
selector): SolidAsyncBatcher<TValue, TSelected>
function createAsyncBatcher<TValue, TSelected>(
   fn, 
   initialOptions, 
selector): SolidAsyncBatcher<TValue, TSelected>

定义于: async-batcher/createAsyncBatcher.ts:128

创建一个兼容 Solid 的 AsyncBatcher 实例,用于管理异步项目批次,并公开所有状态属性的 Solid 信号。

这是 createBatcher hook 的异步版本。与同步版本不同,这个异步 batcher

  • 处理 promises 并返回批处理执行的结果
  • 提供可配置错误行为的错误处理
  • 单独跟踪成功、错误和结算计数
  • 具有批处理执行状态的跟踪
  • 返回批处理函数执行的结果

特性

  • 可配置的批处理大小和等待时间
  • 通过 getShouldExecute 进行自定义批处理逻辑
  • 用于监控批处理操作的事件回调
  • 失败批处理操作的错误处理
  • 自动或手动批处理
  • 所有状态属性(项目、计数等)都公开为 Solid 信号以实现响应性

batcher 收集项目,并根据

  • 最大批次大小(每批项目数)
  • 基于时间的批处理(X 毫秒后处理)
  • 通过 getShouldExecute 进行自定义批处理逻辑

错误处理

  • 如果提供了 onError 处理程序,它将使用错误和 batcher 实例进行调用。
  • 如果 throwOnError 为 true(当没有提供 onError 处理程序时的默认值),错误将被抛出
  • 如果 throwOnError 为 false(当提供 onError 处理程序时的默认值),错误将被吞没
  • onError 和 throwOnError 可以一起使用;处理程序将在任何错误被抛出之前被调用。
  • 可以使用底层的 AsyncBatcher 实例检查错误状态

状态管理和选择器

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

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

可用的状态属性

  • errorCount: 失败的批处理执行次数
  • executionCount: 批处理执行尝试的总次数(成功 + 失败)
  • hasError: 最近一次批处理执行是否导致了错误
  • isExecuting: 当前是否正在执行批处理
  • items: 当前排队等待批处理的项数组
  • lastError: 最近一次失败的批处理执行产生的错误(如果有)
  • lastResult: 最近一次成功的批处理执行产生的 결과
  • settleCount: 已完成(成功或失败)的批处理执行次数
  • successCount: 成功的批处理执行次数

用法示例

tsx
// Default behavior - no reactive state subscriptions
const asyncBatcher = createAsyncBatcher(
  async (items) => {
    const results = await Promise.all(items.map(item => processItem(item)));
    return results;
  },
  {
    maxSize: 10,
    wait: 2000,
    onSuccess: (result) => {
      console.log('Batch processed successfully:', result);
    },
    onError: (error) => {
      console.error('Batch processing failed:', error);
    }
  }
);

// Opt-in to re-render when items or isExecuting changes (optimized for UI updates)
const asyncBatcher = createAsyncBatcher(
  async (items) => {
    const results = await Promise.all(items.map(item => processItem(item)));
    return results;
  },
  { maxSize: 10, wait: 2000 },
  (state) => ({ items: state.items, isExecuting: state.isExecuting })
);

// Opt-in to re-render when error state changes (optimized for error handling)
const asyncBatcher = createAsyncBatcher(
  async (items) => {
    const results = await Promise.all(items.map(item => processItem(item)));
    return results;
  },
  { maxSize: 10, wait: 2000 },
  (state) => ({ hasError: state.hasError, lastError: state.lastError })
);

// Add items to batch
asyncBatcher.addItem(newItem);

// Manually execute batch
const result = await asyncBatcher.execute();

// Access the selected state (will be empty object {} unless selector provided)
const { items, isExecuting } = asyncBatcher.state();
// Default behavior - no reactive state subscriptions
const asyncBatcher = createAsyncBatcher(
  async (items) => {
    const results = await Promise.all(items.map(item => processItem(item)));
    return results;
  },
  {
    maxSize: 10,
    wait: 2000,
    onSuccess: (result) => {
      console.log('Batch processed successfully:', result);
    },
    onError: (error) => {
      console.error('Batch processing failed:', error);
    }
  }
);

// Opt-in to re-render when items or isExecuting changes (optimized for UI updates)
const asyncBatcher = createAsyncBatcher(
  async (items) => {
    const results = await Promise.all(items.map(item => processItem(item)));
    return results;
  },
  { maxSize: 10, wait: 2000 },
  (state) => ({ items: state.items, isExecuting: state.isExecuting })
);

// Opt-in to re-render when error state changes (optimized for error handling)
const asyncBatcher = createAsyncBatcher(
  async (items) => {
    const results = await Promise.all(items.map(item => processItem(item)));
    return results;
  },
  { maxSize: 10, wait: 2000 },
  (state) => ({ hasError: state.hasError, lastError: state.lastError })
);

// Add items to batch
asyncBatcher.addItem(newItem);

// Manually execute batch
const result = await asyncBatcher.execute();

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

类型参数

TValue

TSelected = {}

参数

fn

(items) => Promise<any>

initialOptions

AsyncBatcherOptions<TValue> = {}

选择器

(state) => TSelected

Returns (返回)

SolidAsyncBatcher<TValue, TSelected>

我们的合作伙伴
Code Rabbit
Unkey
订阅 Bytes

您的每周 JavaScript 资讯。每周一免费发送给超过 10 万开发者。

Bytes

无垃圾邮件。您可以随时取消订阅。

订阅 Bytes

您的每周 JavaScript 资讯。每周一免费发送给超过 10 万开发者。

Bytes

无垃圾邮件。您可以随时取消订阅。