@revideo/core

@revideo/core / flow / run

Function: run()

Call Signature

run(runner): ThreadGenerator

Defined in: flow/run.ts:24 

Turn the given generator function into a task.

Parameters

runner

() => ThreadGenerator

A generator function or a factory that creates the generator.

Returns

ThreadGenerator

Remarks

If you want to immediately run the generator in its own thread, you can use threading.spawn instead. This function is useful when you want to pass the created task to other flow functions.

Example

yield* all(
  run(function* () {
    // do things
  }),
  rect.opacity(1, 1),
);

Call Signature

run(name, runner): ThreadGenerator

Defined in: flow/run.ts:46 

Turn the given generator function into a task.

Parameters

name

string

An optional name used when displaying this generator in the UI.

runner

() => ThreadGenerator

A generator function or a factory that creates the generator.

Returns

ThreadGenerator

Remarks

If you want to immediately run the generator in its own thread, you can use threading.spawn instead. This function is useful when you want to pass the created task to other flow functions.

Example

yield* all(
  run(function* () {
    // do things
  }),
  rect.opacity(1, 1),
);