Visualize Your Ideas With Code
import {decorate, threadable} from '../decorators';
import {ThreadGenerator, isThreadGenerator} from '../threading';
import {waitFor} from './scheduling';
decorate(delay, threadable());
/**
* Run the given generator or callback after a specific amount of time.
*
* @example
* ```ts
* yield* delay(1, rect.fill('#ff0000', 2));
* ```
*
* Note that the same animation can be written as:
* ```ts
* yield* waitFor(1),
* yield* rect.fill('#ff0000', 2),
* ```
*
* The reason `delay` exists is to make it easier to pass it to other flow
* functions. For example:
* ```ts
* yield* all(
* rect.opacity(1, 3),
* delay(1, rect.fill('#ff0000', 2));
* );
* ```
*
* @param time - The delay in seconds
* @param task - The task or callback to run after the delay.
*/
export function* delay(
time: number,
task: ThreadGenerator | Callback,
): ThreadGenerator {
yield* waitFor(time);
if (isThreadGenerator(task)) {
yield* task;
} else {
task();
}
}