Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Debounce missing in TypeScript and docs #2763

Open
dricholm opened this issue Aug 16, 2024 · 1 comment
Open

Debounce missing in TypeScript and docs #2763

dricholm opened this issue Aug 16, 2024 · 1 comment
Labels

Comments

@dricholm
Copy link

Description

I see the debounce functionality was added recently in #2760, thank you for that!
Already managed to use it successfully, but noticed that the types haven't been updated to support it so had to use @ts-expect-error to avoid TypeScript errors.
Also there is no mention of it in the docs yet, mainly looked up the functionality in the above PR and in the BullMQ docs.

Could the types be updated to support debounce? I assume it would mean adding debounce?: { id: string; ttl?: number } to JobOptions and removeDebounceKey(debounceKey: string): Promise<number> to Queue. If that's all it would be I could also help in contributing.
Additionally would be good to also mention this useful function in the docs somewhere. Would it only need changes in REFERENCE.md?

Bull version

4.16.0

github-actions bot pushed a commit that referenced this issue Aug 28, 2024
## [4.16.1](v4.16.0...v4.16.1) (2024-08-28)

### Bug Fixes

* **metrics:** use batches include when collecting metrics ([#2765](#2765)) fixes [#2764](#2764) [#2763](#2763) ([8276f72](8276f72))
Copy link

stale bot commented Oct 19, 2024

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix label Oct 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant