Newer version available
You’re viewing the API reference for version 3.0.3, but the latest version is 3.1.0. The latest version include may important updates and fixes.
View Latest Versionfunction createScope
thefrontside/effectionfunction 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
a tuple containing the new scope, and a function to destroy it.