This package has been deprecated

Author message:

throttle primitive moved to @solid-primitives/scheduled

@solid-primitives/throttle
TypeScript icon, indicating that this package has built-in type declarations

1.2.0 • Public • Published

Solid Primitives Throttle

@solid-primitives/throttle

lerna size size stage

Creates a throttled function that invokes at most once per specified time.

When used in an reactive context (effect or component), any throttled function pending to execute will be automatically canceled when the context is cleaned up.

How to use it

const [trigger, clear] = createThrottle((value) => console.log(value), 250));
trigger('my-new-value');

Demo

You may view a working example here: https://codesandbox.io/s/solid-primitives-throttle-h2wni?file=/src/index.tsx

Changelog

Expand Changelog

0.0.100

First version of the throttle primitive.

1.0.3

Cleaned up return types and documentation.

1.0.8

Adding CJS support to package.

1.1.0

Updated to Solid 1.3

1.1.3

General clean-up and improvements by Joe Pea (trusktr)

Package Sidebar

Install

npm i @solid-primitives/throttle

Weekly Downloads

13

Version

1.2.0

License

MIT

Unpacked Size

7.2 kB

Total Files

6

Last publish

Collaborators

  • davedbase
  • lexlohr
  • thetarnav.