async-utilities

async-utilities

Basic Javsacript utility functions and classes to provide class mixin creation and key-addressed debounce, animation, and coroutine functions.

Classes

Classes to extend or instantiate to enable easy access and use of simple utility functions. All classes are provided as a mixin function variant, as well, so the functionality can be added to existing classes, as well.

Debouncer, DebouncerMixin

import { Debouncer, DebouncerMixin } from '.../Debouncer.js'
const db = new Debouncer()
db.debounce('key', () => console.log('Hello!'), 1000)

// 1 second later
// Hello!

debounce(key, func, duration)

Calls the provided function func once after the provided duration.

key uniquely identifies the debounce function. If another debounce is requested with the same key, the previous one is cancelled.

clearDebounce(key)

Cancels the debounce request with the given key.

If key is null, then all debounces are cancelled.

flushDebounce(key)

Calls the debounce request with the provided key now.

If key is null, then all debounces are cancelled.

Animator, AnimatorMixin

import { Animator, AnimatorMixin } from '.../Animator.js'
const an = new Animator()
an.animate('key', (frameNum, deltaTime) => console(frameNum))

// 1000 frames later
// prints 0..999

an.clearAnimation('key')

// no more logs

animate(key, func, callNow = true, duringIdle = false)

Calls the provided function func every frame until cleared. The function is passed both the current frame and time since last frame.

If callNow is true, then the function will be called for the first time immediately.

If duringIdle is true, then the animation function is called during the requestIdleCallback function instead of requestAnimationFrame

clearAnimation(key)

Behaves like ClearDebounce(key) for animations.

Coroutiner, CoroutinerMixin

import { Coroutiner, CoroutinerMixin } from '.../Coroutiner.js'

function* increment() {
  for(let i = 0; i < 1000; i ++) {
    console.log(i)
    yield null
  }
}

const cr = new Coroutiner()
cr.startCoroutine('key', increment())

// prints 0..999

startCoroutine(key, func, duration, callNow = true, duringIdle = false)

Starts a coroutine that runs for the given duration every frame.

See Animator for callNow and duringIdle descriptions.

clearCoroutine(key)

Behaves like ClearDebounce(key) for coroutines.