effect-motion
API Referenceeffect-motionNamespacesSceneFunctions

fork

function fork<A, E, R>(effect): Effect<BranchHandle<A, E>, never,

Function: fork()

function fork<A, E, R>(effect): Effect<BranchHandle<A, E>, never,
  | Runner
| Exclude<Exclude<R, never>, Phaser>>;

Defined in: packages/motion/src/Scene.ts:1160

Start an animation alongside the rest of the scene and continue immediately, without waiting for it.

Type Parameters

Type ParameterDefault type
A-
Enever
Rnever

Parameters

ParameterTypeDescription
effectEffect<A, E, R>The animation to run alongside.

Returns

Effect<BranchHandle<A, E>, never, | Runner | Exclude<Exclude<R, never>, Phaser>>

A handle with finished and fiber.

Remarks

Where all blocks until its branches finish, fork returns at once — so the scene body carries on while the forked animation plays. That is what lets independent timelines overlap, and what makes spawning work in a loop possible.

Note this INVERTS Effect's own fork: the scene's end waits for forked work. A body that returns while forks are still animating keeps producing frames until the last one finishes, so a scene consisting only of a fork still plays in full. For work that should instead be cut off when the scene ends, use background.

The returned handle carries finished — yield it to wait for this branch specifically — and fiber, to interrupt it early.

See

background for work bounded by the scene's end.

Example

Spawn overlapping dots; the scene lives until the last one has faded.

yield* Scene.repeat(
	Scene.fork(
		Effect.gen(function* () {
			const dot = yield* Scene.instantiate("Circle", { radius: 8 });
			yield* dot.pipe(
				Motion.moveTo({ x: 440 }, "1200 millis"),
				Motion.fadeTo(0, "300 millis"),
			);
		}),
	),
	Schedule.fixed("200 millis").pipe(Schedule.upTo({ times: 5 })),
);

On this page