No Princess, Mario

    just-throttle
    TypeScript icon, indicating that this package has built-in type declarations

    4.1.1 • Public • Published

    just-throttle

    Part of a library of zero-dependency npm modules that do just do one thing. Guilt-free utilities for every occasion.

    🍦 Try it

    npm install just-throttle
    yarn add just-throttle

    Return a throttled function

    import throttle from 'just-throttle';
    
    // no matter how many times the function is called, only invoke once within the given interval
    // options: 
    // `leading`: invoke  before interval
    // `trailing`: invoke afer interval
    
    const fn1 = throttle(() => console.log('hello'), 500, {leading: true});
    setInterval(fn1, 400);
    // logs 'hello' immediately and then every 500ms
    
    const fn2 = throttle(() => console.log('hello'), 500, {trailing: true});
    setInterval(fn2, 400);
    // logs 'hello' after 500ms and then every 500ms
    
    const fn3 = throttle(() => console.log('hello'), 500, {leading: true, trailing: true});
    // forces trailing to false
    
    const fn4 = throttle(() => console.log('hello'), 500, { leading: false });
    fn4();
    fn4();
    fn4();
    fn4.cancel();
    // function cancelled before 'hello' is logged
    
    const fn5 = throttle(() => console.log("Hello"), 500);
    fn5();
    fn5();
    fn5();
    fn5.flush();
    // immediately invoke the throttled function

    Install

    npm i just-throttle

    DownloadsWeekly Downloads

    13,385

    Version

    4.1.1

    License

    MIT

    Unpacked Size

    7.52 kB

    Total Files

    9

    Last publish

    Collaborators

    • angus-c