Adding trigger function.

[olafurw]

I'm using the library and it's going great so far. I'm using it to debounce relatively expensive API calls but there are instances where it's likely that a call is already "queued" (not a guarantee) but the user performed an action where I want to call it immediately and clear the underlying call.

And I don't want to call the underlying function, because if there is a queued debounce then I want to avoid calling the API twice, so what I end up doing is something like.

fn();
fn.flush();

So my suggestion is a trigger function (you can rename it to whatever you want, trigger, invoke, run, etc) where it calls the underlying function and clears any queued timers. So then in those instances I can just do fn.trigger()

[sindresorhus]

Makes sense. This needs docs addition in readme and index.d.ts

[olafurw]

Doc things added. Did some refactoring also, hope it's ok.
Now the main functions are kinda boring since they just call each other or call run()

[sindresorhus]

Thanks :)