feat: add queueByKey function for sequential async execution per key #407
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is AI-generated.
Summary
This PR introduces a new
queueByKeyutility in the async module. It wraps an async function and ensures that calls with the same key are run one at a time, in order. Calls with different keys run in parallel.This is helpful when you need to avoid race conditions for grouped operations—like:
• Serializing DB writes by record or table
• Avoiding overlapping API calls for the same user
• Throttling per group without blocking all calls globally
What’s included:
• Full TypeScript support with generics
• Clean error handling and propagation
• Automatic cleanup when queues are empty
• 100% test coverage
• Docs and usage examples
Related issue, if any:
N/A
For any code change,
Does this PR introduce a breaking change?
No
Bundle impact
src/async/queueByKey.tsFootnotes
Function size includes the
importdependencies of the function. ↩