feat(throttle): add trigger method to ThrottleFunction

[aleclarson]

Tip

The owner of this PR can publish a preview release by commenting /publish in this PR. Afterwards, anyone can try it out by running pnpm add radashi@pr<PR_NUMBER>.

Summary

The trigger method lets you skip the throttle queue and invoke the function immediately. This will reset the throttle timeout too.

const logMessage = (message: string) => {
  console.log(`Message: ${message}`)
}
const throttledLog = throttle({ interval: 1000 }, logMessage)

throttledLog('First call')  // Logs immediately
throttledLog('Throttled')   // Doesn't log (throttled)

// Force a log, bypassing the throttle
throttledLog.trigger('Forced log')  // Logs immediately

// Check if it's still throttled
throttledLog.isThrottled()  // => true

For any code change,

• Related documentation has been updated, if needed
• Related tests have been added or updated, if needed

Does this PR introduce a breaking change?

No

Bundle impact

Status	File	Size	Difference (%)
M	src/curry/throttle.ts	262 1	+26 (+11%)

Footnotes

1. Function size includes the import dependencies of the function. ↩

[github-actions]

A new beta version 12.2.0-beta.83909af has been published to NPM. 🚀

To install:

pnpm add radashi@12.2.0-beta.83909af

The radashi@beta tag also includes this PR.