Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
58 lines (41 sloc) 1.8 KB

odis

Odis, the Latin god of modular limitation. 🔮

If you need debounce or throttle, Odis can help. Odis is the Latin god of modular limitation. Odis is a very helpful god.

Odis' name comes from modularis (modular) and modus (limitation). ⚡️

He also believes in being used internally in a project, just drop these lines somewhere in your lib, the only downfall is that you won't have access to Odis' shortcuts, but you also won't be adding anything to the global object if you are properly wrapping your project. 🎉

Like most gods, Odis hates typing. For this reason, he set up very small shortcuts for accessing his functions. ⌚️

odis.debounce(func, delay) may be expressed as odis.debo() or just odis.d(). Note that the delay argument is optional. The default debounce timeout is 210.

odis.throttle(func, delay) may be expressed as odis.thro() or just odis.t(). Again, the delay argument is optional. The default throttle timeout is 42.

I wrote about the origins of odis in this blog post.

CDN

Odis is available via RawGit CDN (v1.1.2):

<script
    src="https://cdn.rawgit.com/ryanpcmcquen/odis/6b6ff20ac218efc34139b836d19c3d0988d5c331/odis.min.js"
></script>

https://cdn.rawgit.com/ryanpcmcquen/odis/6b6ff20ac218efc34139b836d19c3d0988d5c331/odis.min.js

npm

Add it to your project to use it today:

npm install --save odis

Usage

odis.throttle or odis.debounce should be used as a wrapper for the function you want to limit, like so:

document.querySelector('.foo').addEventListener(
    'click',
    odis.throttle(function () {
        console.log('Clicked.');
    },
    1000)
);