AsyncHelper

A helper class to make asynchronous tasks await friendly.

No results

Functions

Functions are methods available for calling on the class

animationFrame( )

: Promise

ASYNC

static

Returns a promise that resolves on next animation frame.

 async method() {
     // do work
     await AsyncHelper.animationFrame();
     // do more work
 }

sleep( millis )
: Promise

ASYNC

static
Returns a promise that resolves after a specified number of milliseconds.
```
 async method() {
     await AsyncHelper.sleep(10);
     // ...
 }
```

waitFor( fn, maxWait60000, interval100 )

: Promise

internal

ASYNC

static

Returns a Promise which resolves when the passed function returns a truthy value.

 async method() {
      / Wait for a maximum of ten seconds for the eventList to be empty
     await AsyncHelper.waitFor(this.eventList.length === 0, 10000);
     // ...
 }

waitForAnimations( element, subtreetrue )
: Promise

internal

ASYNC

static

Returns a promise that resolves when all finite animations on the element have finished.
yield( )
: Promise

ASYNC

static
Returns a promise that resolves as soon as possible, allowing the browser to minimally process other messages. This is the shortest possible delay the browser offers, so be aware that it does not necessarily allow the browser to paint or reflow if used in a long loop. It does, however, allow other async methods to execute.
```
 async method() {
     await AsyncHelper.yield();
     // ...
 }
```

queueMicrotask( fn )

internal

Safe polyfill for queueMicrotask that works in environments where the native API is not available.

When falling back to Promise.resolve().then(fn), exceptions are rethrown outside the Promise to avoid being silently swallowed.

Source path

Core/helper/AsyncHelper.js

Inheritance tree1

AsyncHelper

AsyncHelper

Functions

Source path

Inheritance tree1

Contents