Visualize Your Ideas With Code
feat(core): add `loopUntil` function (#624)
Squigglesb7aa4b57c763
diff --git a/packages/core/src/flow/index.ts b/packages/core/src/flow/index.tsindex ab911e28..1b5bb804 100644--- a/packages/core/src/flow/index.ts+++ b/packages/core/src/flow/index.ts@@ -9,6 +9,7 @@ export * from './chain';export * from './delay';export * from './every';export * from './loop';+export * from './loopUntil';export * from './noop';export * from './run';export * from './scheduling';diff --git a/packages/core/src/flow/loopUntil.ts b/packages/core/src/flow/loopUntil.tsnew file mode 100644index 00000000..95fc43ef--- /dev/null+++ b/packages/core/src/flow/loopUntil.ts@@ -0,0 +1,41 @@+import {useDuration, usePlayback, useThread} from '../utils';+import {decorate, threadable} from '../decorators';+import {ThreadGenerator} from '../threading';+import {LoopCallback} from './loop';++decorate(loopUntil, threadable());+/**+ * Run the given generator until an event occurs.+ *+ * @example+ * ```ts+ * yield* loopUntil(+ * 'Stop Looping',+ * () => circle().position.x(-10, 0.1).to(10, 0.1)+ * );+ * ```+ *+ * @param event - The event.+ * @param factory - A function creating the generator to run. Because generators+ * can't be reset, a new generator is created on each iteration.+ */+export function* loopUntil(+ event: string,+ factory: LoopCallback,+): ThreadGenerator {+ const thread = useThread();+ const step = usePlayback().framesToSeconds(1);+ const targetTime = thread.time() + useDuration(event);++ let iteration = 0;+ while (targetTime - step > thread.fixed) {+ const generator = factory(iteration);+ if (generator) {+ yield* generator;+ } else {+ yield;+ }+ iteration += 1;+ }+ thread.time(targetTime);+}