https://github.com/gkjohnson/js-async-utilities

Set of utility classes to enable easy Coroutines, Debouncing, and Animation
https://github.com/gkjohnson/js-async-utilities

animation async coroutines debounce es6 javascript performance utility

Last synced: 21 days ago
JSON representation

Set of utility classes to enable easy Coroutines, Debouncing, and Animation

• Host: GitHub
• URL: https://github.com/gkjohnson/js-async-utilities
• Owner: gkjohnson
• Created: 2017-08-29T01:07:44.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-08-20T01:45:31.000Z (about 6 years ago)
• Last Synced: 2024-10-05T12:11:10.621Z (about 1 month ago)
• Topics: animation, async, coroutines, debounce, es6, javascript, performance, utility
• Language: JavaScript
• Homepage:
• Size: 116 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
# async-utilities

[![npm version](https://img.shields.io/npm/v/async-utilities.svg?style=flat-square)](https://www.npmjs.com/package/async-utilities)

[![travis build](https://img.shields.io/travis/gkjohnson/js-async-utilities.svg?style=flat-square)](https://travis-ci.org/gkjohnson/js-async-utilities)

[![lgtm code quality](https://img.shields.io/lgtm/grade/javascript/g/gkjohnson/js-async-utilities.svg?style=flat-square&label=code-quality)](https://lgtm.com/projects/g/gkjohnson/js-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

```javascript

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

```javascript

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

```javascript

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.