Potentially outdated documentation

You're reading API reference for version 3.0.3. The latest stable release is version 3.1.0.

function createScope

function createScope(frame?: Frame): [Scope, () => Future<void>]

Create a new scope to serve as an entry point from normal JavaScript execution into Effection.

When creating a fresh scope (as opposed to capturing a reference to an existing one via useScope) it is the responsibility of the creator of the new scope to destroy it when it is no longer needed.

Examples

Example 1

let [scope, destroy] = createScope();
let task = scope.run(function*() {
  //do some long running work
});

//... later
await destroy();

Parameters

frameoptional: Frame

Return Type

[Scope, () => Future<void>]

a tuple containing the new scope, and a function to destroy it.