💖 Support further development

I work hard for every project, including this one and your support means a lot to me!
Consider buying me a coffee. ☕
Thank you for supporting my efforts! 🙏😊



@igorskyflyer

Note

WhyZep()? BecauseZep() allows you to create time-invoked callbacks but withdeferred execution!Zep() does debouncing in avery efficient manner by only creating 1 Timer * - provided bysetInterval. Some use cases are: when you are processing user input but want to wait until they have finished typing or you are using a 3rd-party API that calls an event handler too often - you can throttle those calls or when your event handler does intensive computing and you want to minimize workload. It limits the rate at which a function/handler can be fired/triggered, thus increasing performance/responsiveness of your product.

🕵🏼 Usage

npm i"@igor.dvlpr/zep"

🤹🏼 API

Types

typeZepCallback=(...args:any[])=>void

typeZepErrorHandler=(error:unknown)=>void

typeZepEventHandler=()=>void

Methods

constructor(callback:ZepCallback,time?:number):Zep

import{Zep}from'@igor.dvlpr/zep'// pass an arrow functionconstzep:Zep=newZep((value:string)=>{// code to limit its execution rate},1500)functionmyFunction(value:string){/* some code */}// or an existing functionconstzep:Zep=newZep(myFunction,1500)//  You can have as many arguments in your callback function as you want.

onCancelled(handler:ZepEventHandler):Zep

onAborted(handler:ZepEventHandler):Zep

onBeforeRun(handler:ZepEventHandler):Zep

onAfterRun(handler:ZepEventHandler):Zep

onCompleted(handler:ZepEventHandler):Zep

onError(handler:ZepEventHandler,error:Error):Zep

abort():void

cancel():void

run(...args):void

writeStats():void

executionCount:number

isWaiting:boolean

isRunning:boolean

wasCancelled:boolean

wasAborted:boolean

✨ Example

import{Zep}from'@igor.dvlpr/zep'// pass an arrow functionconstzep:Zep=newZep((value:string)=>{// code to limit its execution rate},1500)// then pass Zep's run() method to the event instead the original function// codeconstpicker=vscode.window.createQuickPick()// this is by default triggered each time a user types a character inside the QuickPickpicker.onDidChangeValue((e:string)=>{zep.run(e)}// due to the nature of JavaScript the following WON'T WORK,// when you pass a class method as a parameter that// method will get detached from the class and lose its track of <this>,// which will be globalThis/undefined, thus resulting in an error,picker.onDidChangeValue(zep.run)// but you could use any of the 2 techniques// ****functionchangeHandler():void{zep.run()}// and then use that wrapper-functionpicker.onDidChangeValue(changeHandler)// ****// or// ****constchangeHandler:Function=zep.run.bind(zep)picker.onDidChangeValue(changeHandler)// ****// by using Zep we can wait for the user to finish their input// if they haven't typed a single letter = the onDidChangeValue wasn't// triggered for 1500ms (1.5s) we assume they finished typing// more code

📝 Changelog

🪪 License

🧬 Related